aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/ts/containers
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-10-19 00:31:38 +0800
committerFabio Berger <me@fabioberger.com>2018-10-19 00:31:38 +0800
commitc4ae91c7c5aaa2d6e278448667bf828162be93bc (patch)
tree46843ed4273b158e0313897d2b5029516c4222ba /packages/website/ts/containers
parent8b62b350b1fed6a0d8827ca9ed5fcec3e78ae82f (diff)
downloaddexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.gz
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.bz2
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.lz
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.xz
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.zst
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.zip
Update doc ref markdown sections
Diffstat (limited to 'packages/website/ts/containers')
-rw-r--r--packages/website/ts/containers/connect_documentation.ts19
-rw-r--r--packages/website/ts/containers/contract_wrappers_documentation.ts13
-rw-r--r--packages/website/ts/containers/json_schemas_documentation.ts31
-rw-r--r--packages/website/ts/containers/order_utils_documentation.ts14
-rw-r--r--packages/website/ts/containers/order_watcher_documentation.ts14
-rw-r--r--packages/website/ts/containers/smart_contracts_documentation.ts8
-rw-r--r--packages/website/ts/containers/sol_compiler_documentation.ts19
-rw-r--r--packages/website/ts/containers/sol_cov_documentation.ts20
-rw-r--r--packages/website/ts/containers/subproviders_documentation.ts18
-rw-r--r--packages/website/ts/containers/web3_wrapper_documentation.ts13
-rw-r--r--packages/website/ts/containers/zero_ex_js_documentation.ts15
11 files changed, 124 insertions, 60 deletions
diff --git a/packages/website/ts/containers/connect_documentation.ts b/packages/website/ts/containers/connect_documentation.ts
index 074839385..0f11e0809 100644
--- a/packages/website/ts/containers/connect_documentation.ts
+++ b/packages/website/ts/containers/connect_documentation.ts
@@ -9,9 +9,10 @@ import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdownV1 = require('md/docs/connect/1.0.0/introduction');
-const IntroMarkdownV2 = require('md/docs/connect/2.0.0/introduction');
-const InstallationMarkdownV1 = require('md/docs/connect/1.0.0/installation');
+const IntroMarkdown1 = require('md/docs/connect/1/introduction');
+const IntroMarkdown2 = require('md/docs/connect/2/introduction');
+const InstallationMarkdown1 = require('md/docs/connect/1/installation');
+const InstallationMarkdown3 = require('md/docs/connect/3/installation');
/* tslint:enable:no-var-requires */
const markdownSections = {
@@ -30,12 +31,16 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [markdownSections.introduction]: IntroMarkdownV1,
- [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
},
'2.0.0-rc.1': {
- [markdownSections.introduction]: IntroMarkdownV2,
- [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdown2,
+ [markdownSections.installation]: InstallationMarkdown1,
+ },
+ '3.0.2': {
+ [markdownSections.introduction]: IntroMarkdown2,
+ [markdownSections.installation]: InstallationMarkdown3,
},
},
markdownSections,
diff --git a/packages/website/ts/containers/contract_wrappers_documentation.ts b/packages/website/ts/containers/contract_wrappers_documentation.ts
index 5bf2a4e1f..4c05605e3 100644
--- a/packages/website/ts/containers/contract_wrappers_documentation.ts
+++ b/packages/website/ts/containers/contract_wrappers_documentation.ts
@@ -9,8 +9,9 @@ import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdown = require('md/docs/contract_wrappers/introduction');
-const InstallMarkdown = require('md/docs/contract_wrappers/installation');
+const IntroMarkdown1 = require('md/docs/contract_wrappers/1/introduction');
+const InstallMarkdownV1 = require('md/docs/contract_wrappers/1/installation');
+const InstallMarkdownV2 = require('md/docs/contract_wrappers/2/installation');
/* tslint:enable:no-var-requires */
const markdownSections = {
@@ -29,8 +30,12 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [markdownSections.introduction]: IntroMarkdown,
- [markdownSections.installation]: InstallMarkdown,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallMarkdownV1,
+ },
+ '3.0.0': {
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallMarkdownV2,
},
},
markdownSections,
diff --git a/packages/website/ts/containers/json_schemas_documentation.ts b/packages/website/ts/containers/json_schemas_documentation.ts
index 38cdc909a..cb5918784 100644
--- a/packages/website/ts/containers/json_schemas_documentation.ts
+++ b/packages/website/ts/containers/json_schemas_documentation.ts
@@ -9,11 +9,14 @@ import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdownV1 = require('md/docs/json_schemas/1.0.0/introduction');
-const InstallationMarkdownV1 = require('md/docs/json_schemas/1.0.0/installation');
-const UsageMarkdownV1 = require('md/docs/json_schemas/1.0.0/usage');
-const SchemasMarkdownV1 = require('md/docs/json_schemas/1.0.0/schemas');
-const SchemasMarkdownV2 = require('md/docs/json_schemas/2.0.0/schemas');
+const IntroMarkdown1 = require('md/docs/json_schemas/1/introduction');
+const IntroMarkdown3 = require('md/docs/json_schemas/3/introduction');
+const InstallationMarkdown1 = require('md/docs/json_schemas/1/installation');
+const InstallationMarkdown3 = require('md/docs/json_schemas/3/installation');
+const usageMarkdown1 = require('md/docs/json_schemas/1/usage');
+const usageMarkdown3 = require('md/docs/json_schemas/3/usage');
+const SchemasMarkdownV1 = require('md/docs/json_schemas/1/schemas');
+const SchemasMarkdownV2 = require('md/docs/json_schemas/2/schemas');
/* tslint:enable:no-var-requires */
const markdownSections = {
@@ -35,16 +38,22 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [markdownSections.introduction]: IntroMarkdownV1,
- [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
[markdownSections.schemas]: SchemasMarkdownV1,
- [markdownSections.usage]: UsageMarkdownV1,
+ [markdownSections.usage]: usageMarkdown1,
},
'1.0.0': {
- [markdownSections.introduction]: IntroMarkdownV1,
- [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
[markdownSections.schemas]: SchemasMarkdownV2,
- [markdownSections.usage]: UsageMarkdownV1,
+ [markdownSections.usage]: usageMarkdown1,
+ },
+ '2.0.0': {
+ [markdownSections.introduction]: IntroMarkdown3,
+ [markdownSections.installation]: InstallationMarkdown3,
+ [markdownSections.schemas]: SchemasMarkdownV2,
+ [markdownSections.usage]: usageMarkdown3,
},
},
markdownSections,
diff --git a/packages/website/ts/containers/order_utils_documentation.ts b/packages/website/ts/containers/order_utils_documentation.ts
index ea083e6a6..f1d794988 100644
--- a/packages/website/ts/containers/order_utils_documentation.ts
+++ b/packages/website/ts/containers/order_utils_documentation.ts
@@ -9,8 +9,10 @@ import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdownV1 = require('md/docs/order_utils/1.0.0/introduction');
-const InstallationMarkdownV1 = require('md/docs/order_utils/1.0.0/installation');
+const IntroMarkdown1 = require('md/docs/order_utils/1/introduction');
+const InstallationMarkdown1 = require('md/docs/order_utils/1/installation');
+const IntroMarkdown2 = require('md/docs/order_utils/2/introduction');
+const InstallationMarkdown2 = require('md/docs/order_utils/2/installation');
/* tslint:enable:no-var-requires */
const markdownSections = {
@@ -29,8 +31,12 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [markdownSections.introduction]: IntroMarkdownV1,
- [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
+ },
+ '2.0.0': {
+ [markdownSections.introduction]: IntroMarkdown2,
+ [markdownSections.installation]: InstallationMarkdown2,
},
},
markdownSections,
diff --git a/packages/website/ts/containers/order_watcher_documentation.ts b/packages/website/ts/containers/order_watcher_documentation.ts
index 83caf29ed..ac92e6a22 100644
--- a/packages/website/ts/containers/order_watcher_documentation.ts
+++ b/packages/website/ts/containers/order_watcher_documentation.ts
@@ -9,8 +9,10 @@ import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdown = require('md/docs/order_watcher/introduction');
-const InstallationMarkdown = require('md/docs/order_watcher/installation');
+const IntroMarkdown1 = require('md/docs/order_watcher/1/introduction');
+const InstallationMarkdown1 = require('md/docs/order_watcher/1/installation');
+const IntroMarkdown2 = require('md/docs/order_watcher/2/introduction');
+const InstallationMarkdown2 = require('md/docs/order_watcher/2/installation');
/* tslint:enable:no-var-requires */
const markdownSections = {
@@ -29,8 +31,12 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [markdownSections.introduction]: IntroMarkdown,
- [markdownSections.installation]: InstallationMarkdown,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
+ },
+ '2.2.0': {
+ [markdownSections.introduction]: IntroMarkdown2,
+ [markdownSections.installation]: InstallationMarkdown2,
},
},
markdownSections,
diff --git a/packages/website/ts/containers/smart_contracts_documentation.ts b/packages/website/ts/containers/smart_contracts_documentation.ts
index fc34b5f61..57c98fa3b 100644
--- a/packages/website/ts/containers/smart_contracts_documentation.ts
+++ b/packages/website/ts/containers/smart_contracts_documentation.ts
@@ -10,8 +10,8 @@ import { DocPackages, ScreenWidths, SmartContractDocSections as Sections } from
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdownV1 = require('md/docs/smart_contracts/1.0.0/introduction');
-const IntroMarkdownV2 = require('md/docs/smart_contracts/2.0.0/introduction');
+const IntroMarkdown1 = require('md/docs/smart_contracts/1/introduction');
+const IntroMarkdown2 = require('md/docs/smart_contracts/2/introduction');
/* tslint:enable:no-var-requires */
const docsInfoConfig: DocsInfoConfig = {
@@ -25,10 +25,10 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [Sections.Introduction]: IntroMarkdownV1,
+ [Sections.Introduction]: IntroMarkdown1,
},
'2.0.0': {
- [Sections.Introduction]: IntroMarkdownV2,
+ [Sections.Introduction]: IntroMarkdown2,
},
},
markdownSections: {
diff --git a/packages/website/ts/containers/sol_compiler_documentation.ts b/packages/website/ts/containers/sol_compiler_documentation.ts
index 03da8a25f..f3a793e80 100644
--- a/packages/website/ts/containers/sol_compiler_documentation.ts
+++ b/packages/website/ts/containers/sol_compiler_documentation.ts
@@ -9,9 +9,11 @@ import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdownV1 = require('md/docs/sol-compiler/introduction');
-const InstallationMarkdownV1 = require('md/docs/sol-compiler/installation');
-const UsageMarkdown = require('md/docs/sol-compiler/usage');
+const IntroMarkdown1 = require('md/docs/sol-compiler/1/introduction');
+const InstallationMarkdown1 = require('md/docs/sol-compiler/1/installation');
+const InstallationMarkdown2 = require('md/docs/sol-compiler/2/installation');
+const UsageMarkdown1 = require('md/docs/sol-compiler/1/usage');
+const UsageMarkdown2 = require('md/docs/sol-compiler/2/usage');
/* tslint:enable:no-var-requires */
const markdownSections = {
@@ -31,9 +33,14 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [markdownSections.introduction]: IntroMarkdownV1,
- [markdownSections.installation]: InstallationMarkdownV1,
- [markdownSections.usage]: UsageMarkdown,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
+ [markdownSections.usage]: UsageMarkdown1,
+ },
+ '1.1.8': {
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown2,
+ [markdownSections.usage]: UsageMarkdown2,
},
},
markdownSections,
diff --git a/packages/website/ts/containers/sol_cov_documentation.ts b/packages/website/ts/containers/sol_cov_documentation.ts
index 5943be009..8944ec70a 100644
--- a/packages/website/ts/containers/sol_cov_documentation.ts
+++ b/packages/website/ts/containers/sol_cov_documentation.ts
@@ -9,9 +9,12 @@ import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdownV1 = require('md/docs/sol_cov/introduction');
-const InstallationMarkdownV1 = require('md/docs/sol_cov/installation');
-const UsageMarkdown = require('md/docs/sol_cov/usage');
+const IntroMarkdown1 = require('md/docs/sol_cov/1/introduction');
+const InstallationMarkdown1 = require('md/docs/sol_cov/1/installation');
+const UsageMarkdown1 = require('md/docs/sol_cov/1/usage');
+const IntroMarkdown2 = require('md/docs/sol_cov/2/introduction');
+const InstallationMarkdown2 = require('md/docs/sol_cov/2/installation');
+const UsageMarkdown2 = require('md/docs/sol_cov/2/usage');
/* tslint:enable:no-var-requires */
const markdownSections = {
@@ -31,9 +34,14 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [markdownSections.introduction]: IntroMarkdownV1,
- [markdownSections.installation]: InstallationMarkdownV1,
- [markdownSections.usage]: UsageMarkdown,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
+ [markdownSections.usage]: UsageMarkdown1,
+ },
+ '2.1.8': {
+ [markdownSections.introduction]: IntroMarkdown2,
+ [markdownSections.installation]: InstallationMarkdown2,
+ [markdownSections.usage]: UsageMarkdown2,
},
},
markdownSections,
diff --git a/packages/website/ts/containers/subproviders_documentation.ts b/packages/website/ts/containers/subproviders_documentation.ts
index b00551a79..0e421777b 100644
--- a/packages/website/ts/containers/subproviders_documentation.ts
+++ b/packages/website/ts/containers/subproviders_documentation.ts
@@ -9,9 +9,10 @@ import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdownV1 = require('md/docs/subproviders/introduction');
-const InstallationMarkdownV1 = require('md/docs/subproviders/installation');
-const LedgerNodeHidMarkdown = require('md/docs/subproviders/ledger_node_hid');
+const IntroMarkdown1 = require('md/docs/subproviders/1/introduction');
+const InstallationMarkdown1 = require('md/docs/subproviders/1/installation');
+const InstallationMarkdown2 = require('md/docs/subproviders/2/installation');
+const LedgerNodeHidMarkdown1 = require('md/docs/subproviders/1/ledger_node_hid');
/* tslint:enable:no-var-requires */
const docSections = {
@@ -31,9 +32,14 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [docSections.introduction]: IntroMarkdownV1,
- [docSections.installation]: InstallationMarkdownV1,
- [docSections.ledgerNodeHid]: LedgerNodeHidMarkdown,
+ [docSections.introduction]: IntroMarkdown1,
+ [docSections.installation]: InstallationMarkdown1,
+ [docSections.ledgerNodeHid]: LedgerNodeHidMarkdown1,
+ },
+ '2.1.0': {
+ [docSections.introduction]: IntroMarkdown1,
+ [docSections.installation]: InstallationMarkdown2,
+ [docSections.ledgerNodeHid]: LedgerNodeHidMarkdown1,
},
},
markdownSections: docSections,
diff --git a/packages/website/ts/containers/web3_wrapper_documentation.ts b/packages/website/ts/containers/web3_wrapper_documentation.ts
index f064a1567..9c8c34621 100644
--- a/packages/website/ts/containers/web3_wrapper_documentation.ts
+++ b/packages/website/ts/containers/web3_wrapper_documentation.ts
@@ -9,8 +9,9 @@ import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
-const IntroMarkdownV1 = require('md/docs/web3_wrapper/introduction');
-const InstallationMarkdownV1 = require('md/docs/web3_wrapper/installation');
+const IntroMarkdown1 = require('md/docs/web3_wrapper/1/introduction');
+const InstallationMarkdown1 = require('md/docs/web3_wrapper/1/installation');
+const InstallationMarkdown2 = require('md/docs/web3_wrapper/2/installation');
/* tslint:enable:no-var-requires */
const markdownSections = {
@@ -29,8 +30,12 @@ const docsInfoConfig: DocsInfoConfig = {
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [markdownSections.introduction]: IntroMarkdownV1,
- [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
+ },
+ '3.1.0': {
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown2,
},
},
markdownSections,
diff --git a/packages/website/ts/containers/zero_ex_js_documentation.ts b/packages/website/ts/containers/zero_ex_js_documentation.ts
index 9c0de32a8..e0ea6e275 100644
--- a/packages/website/ts/containers/zero_ex_js_documentation.ts
+++ b/packages/website/ts/containers/zero_ex_js_documentation.ts
@@ -15,8 +15,8 @@ const AsyncMarkdownV0 = require('md/docs/0xjs/0.0.1/async');
const ErrorsMarkdownV0 = require('md/docs/0xjs/0.0.1/errors');
const versioningMarkdownV0 = require('md/docs/0xjs/0.0.1/versioning');
-const IntroMarkdownV1 = require('md/docs/0xjs/1.0.1/introduction');
-const InstallationMarkdownV1 = require('md/docs/0xjs/1.0.1/installation');
+const IntroMarkdown1 = require('md/docs/0xjs/1.0.1/introduction');
+const InstallationMarkdown1 = require('md/docs/0xjs/1.0.1/installation');
const AsyncMarkdownV1 = require('md/docs/0xjs/1.0.1/async');
const ErrorsMarkdownV1 = ErrorsMarkdownV0;
const versioningMarkdownV1 = require('md/docs/0xjs/1.0.1/versioning');
@@ -56,8 +56,15 @@ const docsInfoConfig: DocsInfoConfig = {
[markdownSections.errors]: ErrorsMarkdownV0,
},
'1.0.1': {
- [markdownSections.introduction]: IntroMarkdownV1,
- [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
+ [markdownSections.versioning]: versioningMarkdownV1,
+ [markdownSections.async]: AsyncMarkdownV1,
+ [markdownSections.errors]: ErrorsMarkdownV1,
+ },
+ '2.0.0': {
+ [markdownSections.introduction]: IntroMarkdown1,
+ [markdownSections.installation]: InstallationMarkdown1,
[markdownSections.versioning]: versioningMarkdownV1,
[markdownSections.async]: AsyncMarkdownV1,
[markdownSections.errors]: ErrorsMarkdownV1,