aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-22 02:55:59 +0800
committerFabio Berger <me@fabioberger.com>2018-03-22 02:55:59 +0800
commite1341bc6d957d70a386c858cbdb64af5f284fd07 (patch)
tree5c6d76b4d179d51551c2bd051d48b04187033ef6 /packages/website
parentd437a660198a36c585f6cd5fe1bd13643da52ecb (diff)
downloaddexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.gz
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.bz2
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.lz
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.xz
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.tar.zst
dexon-sol-tools-e1341bc6d957d70a386c858cbdb64af5f284fd07.zip
Move docs to page and add link to docs to README
Diffstat (limited to 'packages/website')
-rw-r--r--packages/website/md/docs/json_schemas/usage.md14
-rw-r--r--packages/website/ts/containers/json_schemas_documentation.ts4
2 files changed, 18 insertions, 0 deletions
diff --git a/packages/website/md/docs/json_schemas/usage.md b/packages/website/md/docs/json_schemas/usage.md
new file mode 100644
index 000000000..372c0b541
--- /dev/null
+++ b/packages/website/md/docs/json_schemas/usage.md
@@ -0,0 +1,14 @@
+The following example shows you how to validate an 0x order using the `@0xproject/json-schemas` package.
+
+```javascript
+import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas';
+
+const {orderSchema} = schemas;
+const validator = new SchemaValidator();
+
+const order = {
+ ...
+};
+const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors
+const isValid: boolean = validator.isValid(order, orderSchema); // Only returns boolean
+```
diff --git a/packages/website/ts/containers/json_schemas_documentation.ts b/packages/website/ts/containers/json_schemas_documentation.ts
index 42e441212..154c65ffc 100644
--- a/packages/website/ts/containers/json_schemas_documentation.ts
+++ b/packages/website/ts/containers/json_schemas_documentation.ts
@@ -14,12 +14,14 @@ import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
const IntroMarkdown = require('md/docs/json_schemas/introduction');
const InstallationMarkdown = require('md/docs/json_schemas/installation');
+const UsageMarkdown = require('md/docs/json_schemas/usage');
const SchemasMarkdown = require('md/docs/json_schemas/schemas');
/* tslint:enable:no-var-requires */
const docSections = {
introduction: 'introduction',
installation: 'installation',
+ usage: 'usage',
schemaValidator: 'schemaValidator',
schemas: 'schemas',
};
@@ -32,6 +34,7 @@ const docsInfoConfig: DocsInfoConfig = {
menu: {
introduction: [docSections.introduction],
install: [docSections.installation],
+ usage: [docSections.usage],
schemaValidator: [docSections.schemaValidator],
schemas: [docSections.schemas],
},
@@ -39,6 +42,7 @@ const docsInfoConfig: DocsInfoConfig = {
[docSections.introduction]: IntroMarkdown,
[docSections.installation]: InstallationMarkdown,
[docSections.schemas]: SchemasMarkdown,
+ [docSections.usage]: UsageMarkdown,
},
sectionNameToModulePath: {
[docSections.schemaValidator]: ['"json-schemas/src/schema_validator"'],