aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-02 03:00:45 +0800
committerFabio Berger <me@fabioberger.com>2018-08-02 03:00:45 +0800
commit2494af99aad4dd58c0d4e647dedf72946cb3c20b (patch)
treed2c20e41b4cd11874a222897970b2597b2e03092
parente5b93d1f0292cb6cc38d3f92d623b27cba6ac233 (diff)
downloaddexon-sol-tools-2494af99aad4dd58c0d4e647dedf72946cb3c20b.tar.gz
dexon-sol-tools-2494af99aad4dd58c0d4e647dedf72946cb3c20b.tar.zst
dexon-sol-tools-2494af99aad4dd58c0d4e647dedf72946cb3c20b.zip
Prefix menu and sections with markdown as that is all the should now be defined
-rw-r--r--packages/react-docs/src/docs_info.ts9
-rw-r--r--packages/react-docs/src/types.ts4
-rw-r--r--packages/website/ts/containers/connect_documentation.ts20
-rw-r--r--packages/website/ts/containers/ethereum_types_documentation.ts16
-rw-r--r--packages/website/ts/containers/json_schemas_documentation.ts24
-rw-r--r--packages/website/ts/containers/order_utils_documentation.ts18
-rw-r--r--packages/website/ts/containers/smart_contracts_documentation.ts4
-rw-r--r--packages/website/ts/containers/sol_compiler_documentation.ts22
-rw-r--r--packages/website/ts/containers/sol_cov_documentation.ts28
-rw-r--r--packages/website/ts/containers/subproviders_documentation.ts30
-rw-r--r--packages/website/ts/containers/web3_wrapper_documentation.ts8
-rw-r--r--packages/website/ts/containers/zero_ex_js_documentation.ts32
12 files changed, 85 insertions, 130 deletions
diff --git a/packages/react-docs/src/docs_info.ts b/packages/react-docs/src/docs_info.ts
index dd3cb9a96..0637f3e65 100644
--- a/packages/react-docs/src/docs_info.ts
+++ b/packages/react-docs/src/docs_info.ts
@@ -28,21 +28,16 @@ export class DocsInfo {
public sectionNameToMarkdownByVersion: SectionNameToMarkdownByVersion;
public contractsByVersionByNetworkId?: ContractsByVersionByNetworkId;
public typeConfigs: DocsInfoTypeConfigs;
- private readonly _docsInfo: DocsInfoConfig;
constructor(config: DocsInfoConfig) {
this.id = config.id;
this.type = config.type;
- this.menu = config.menu;
+ this.menu = config.markdownMenu;
this.displayName = config.displayName;
this.packageUrl = config.packageUrl;
- this.sections = config.sections;
+ this.sections = config.markdownSections;
this.sectionNameToMarkdownByVersion = config.sectionNameToMarkdownByVersion;
this.contractsByVersionByNetworkId = config.contractsByVersionByNetworkId;
this.typeConfigs = config.typeConfigs;
- this._docsInfo = config;
- }
- public getMenu(selectedVersion?: string): { [section: string]: string[] } {
- return this._docsInfo.menu;
}
public getMenuSubsectionsBySection(docAgnosticFormat?: DocAgnosticFormat): MenuSubsectionsBySection {
const menuSubsectionsBySection = {} as MenuSubsectionsBySection;
diff --git a/packages/react-docs/src/types.ts b/packages/react-docs/src/types.ts
index ca869df1c..aebd823db 100644
--- a/packages/react-docs/src/types.ts
+++ b/packages/react-docs/src/types.ts
@@ -7,8 +7,8 @@ export interface DocsInfoConfig {
type: SupportedDocJson;
displayName: string;
packageUrl: string;
- menu: DocsMenu;
- sections: SectionsMap;
+ markdownMenu: DocsMenu;
+ markdownSections: SectionsMap;
sectionNameToMarkdownByVersion: SectionNameToMarkdownByVersion;
contractsByVersionByNetworkId?: ContractsByVersionByNetworkId;
typeConfigs?: DocsInfoTypeConfigs;
diff --git a/packages/website/ts/containers/connect_documentation.ts b/packages/website/ts/containers/connect_documentation.ts
index 74464e650..8e3b8d1c9 100644
--- a/packages/website/ts/containers/connect_documentation.ts
+++ b/packages/website/ts/containers/connect_documentation.ts
@@ -14,7 +14,7 @@ const IntroMarkdownV1 = require('md/docs/connect/1.0.0/introduction');
const InstallationMarkdownV1 = require('md/docs/connect/1.0.0/installation');
/* tslint:enable:no-var-requires */
-const connectDocSections = {
+const markdownSections = {
introduction: 'introduction',
installation: 'installation',
httpClient: 'httpClient',
@@ -27,20 +27,20 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: '0x Connect',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
- introduction: [connectDocSections.introduction],
- install: [connectDocSections.installation],
- httpClient: [connectDocSections.httpClient],
- webSocketOrderbookChannel: [connectDocSections.webSocketOrderbookChannel],
- types: [connectDocSections.types],
+ markdownMenu: {
+ introduction: [markdownSections.introduction],
+ install: [markdownSections.installation],
+ httpClient: [markdownSections.httpClient],
+ webSocketOrderbookChannel: [markdownSections.webSocketOrderbookChannel],
+ types: [markdownSections.types],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [connectDocSections.introduction]: IntroMarkdownV1,
- [connectDocSections.installation]: InstallationMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdownV1,
+ [markdownSections.installation]: InstallationMarkdownV1,
},
},
- sections: connectDocSections,
+ markdownSections: markdownSections,
typeConfigs: {
typeNameToExternalLink: {
Provider: constants.URL_WEB3_PROVIDER_DOCS,
diff --git a/packages/website/ts/containers/ethereum_types_documentation.ts b/packages/website/ts/containers/ethereum_types_documentation.ts
index 041a6bea3..5f08e0236 100644
--- a/packages/website/ts/containers/ethereum_types_documentation.ts
+++ b/packages/website/ts/containers/ethereum_types_documentation.ts
@@ -14,7 +14,7 @@ const IntroMarkdown = require('md/docs/ethereum_types/introduction');
const InstallationMarkdown = require('md/docs/ethereum_types/installation');
/* tslint:enable:no-var-requires */
-const docSections = {
+const markdownSections = {
introduction: 'introduction',
installation: 'installation',
types: docConstants.TYPES_SECTION_NAME,
@@ -25,18 +25,18 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: 'Ethereum Types',
packageUrl: 'https://github.com/0xProject/0x-monorepo/packages/ethereum-types',
- menu: {
- introduction: [docSections.introduction],
- install: [docSections.installation],
- types: [docSections.types],
+ markdownMenu: {
+ introduction: [markdownSections.introduction],
+ install: [markdownSections.installation],
+ types: [markdownSections.types],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [docSections.introduction]: IntroMarkdown,
- [docSections.installation]: InstallationMarkdown,
+ [markdownSections.introduction]: IntroMarkdown,
+ [markdownSections.installation]: InstallationMarkdown,
},
},
- sections: docSections,
+ markdownSections: markdownSections,
typeConfigs: {
typeNameToExternalLink: {
BigNumber: constants.URL_BIGNUMBERJS_GITHUB,
diff --git a/packages/website/ts/containers/json_schemas_documentation.ts b/packages/website/ts/containers/json_schemas_documentation.ts
index 3ecc0f312..f88cec6ec 100644
--- a/packages/website/ts/containers/json_schemas_documentation.ts
+++ b/packages/website/ts/containers/json_schemas_documentation.ts
@@ -15,7 +15,7 @@ const UsageMarkdownV1 = require('md/docs/json_schemas/1.0.0/usage');
const SchemasMarkdownV1 = require('md/docs/json_schemas/1.0.0/schemas');
/* tslint:enable:no-var-requires */
-const docSections = {
+const markdownSections = {
introduction: 'introduction',
installation: 'installation',
usage: 'usage',
@@ -28,22 +28,22 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: 'JSON Schemas',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
- introduction: [docSections.introduction],
- install: [docSections.installation],
- usage: [docSections.usage],
- schemaValidator: [docSections.schemaValidator],
- schemas: [docSections.schemas],
+ markdownMenu: {
+ introduction: [markdownSections.introduction],
+ install: [markdownSections.installation],
+ usage: [markdownSections.usage],
+ schemaValidator: [markdownSections.schemaValidator],
+ schemas: [markdownSections.schemas],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [docSections.introduction]: IntroMarkdownV1,
- [docSections.installation]: InstallationMarkdownV1,
- [docSections.schemas]: SchemasMarkdownV1,
- [docSections.usage]: UsageMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdownV1,
+ [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.schemas]: SchemasMarkdownV1,
+ [markdownSections.usage]: UsageMarkdownV1,
},
},
- sections: docSections,
+ markdownSections: markdownSections,
typeConfigs: {
typeNameToExternalLink: {
Schema:
diff --git a/packages/website/ts/containers/order_utils_documentation.ts b/packages/website/ts/containers/order_utils_documentation.ts
index 29cbf9501..9af863d8a 100644
--- a/packages/website/ts/containers/order_utils_documentation.ts
+++ b/packages/website/ts/containers/order_utils_documentation.ts
@@ -14,7 +14,7 @@ const IntroMarkdownV1 = require('md/docs/order_utils/1.0.0/introduction');
const InstallationMarkdownV1 = require('md/docs/order_utils/1.0.0/installation');
/* tslint:enable:no-var-requires */
-const docSections = {
+const markdownSections = {
introduction: 'introduction',
installation: 'installation',
usage: 'usage',
@@ -26,19 +26,19 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: 'Order utils',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
- introduction: [docSections.introduction],
- install: [docSections.installation],
- usage: [docSections.usage],
- types: [docSections.types],
+ markdownMenu: {
+ introduction: [markdownSections.introduction],
+ install: [markdownSections.installation],
+ usage: [markdownSections.usage],
+ types: [markdownSections.types],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [docSections.introduction]: IntroMarkdownV1,
- [docSections.installation]: InstallationMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdownV1,
+ [markdownSections.installation]: InstallationMarkdownV1,
},
},
- sections: docSections,
+ markdownSections: markdownSections,
typeConfigs: {
typeNameToExternalLink: {
BigNumber: constants.URL_BIGNUMBERJS_GITHUB,
diff --git a/packages/website/ts/containers/smart_contracts_documentation.ts b/packages/website/ts/containers/smart_contracts_documentation.ts
index e3a1bd7a6..a2b3545ae 100644
--- a/packages/website/ts/containers/smart_contracts_documentation.ts
+++ b/packages/website/ts/containers/smart_contracts_documentation.ts
@@ -18,7 +18,7 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.Doxity,
displayName: '0x Smart Contracts',
packageUrl: 'https://github.com/0xProject/contracts',
- menu: {
+ markdownMenu: {
introduction: [Sections.Introduction],
contracts: [Sections.Exchange, Sections.TokenRegistry, Sections.ZRXToken, Sections.TokenTransferProxy],
},
@@ -27,7 +27,7 @@ const docsInfoConfig: DocsInfoConfig = {
[Sections.Introduction]: IntroMarkdownV1,
},
},
- sections: {
+ markdownSections: {
Introduction: Sections.Introduction,
Exchange: Sections.Exchange,
TokenTransferProxy: Sections.TokenTransferProxy,
diff --git a/packages/website/ts/containers/sol_compiler_documentation.ts b/packages/website/ts/containers/sol_compiler_documentation.ts
index bd6a85c83..635c2112b 100644
--- a/packages/website/ts/containers/sol_compiler_documentation.ts
+++ b/packages/website/ts/containers/sol_compiler_documentation.ts
@@ -14,7 +14,7 @@ const InstallationMarkdownV1 = require('md/docs/sol-compiler/installation');
const UsageMarkdown = require('md/docs/sol-compiler/usage');
/* tslint:enable:no-var-requires */
-const docSections = {
+const markdownSections = {
introduction: 'introduction',
installation: 'installation',
usage: 'usage',
@@ -27,21 +27,21 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: 'Solidity Compiler',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
- introduction: [docSections.introduction],
- install: [docSections.installation],
- usage: [docSections.usage],
- compiler: [docSections.compiler],
- types: [docSections.types],
+ markdownMenu: {
+ introduction: [markdownSections.introduction],
+ install: [markdownSections.installation],
+ usage: [markdownSections.usage],
+ compiler: [markdownSections.compiler],
+ types: [markdownSections.types],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [docSections.introduction]: IntroMarkdownV1,
- [docSections.installation]: InstallationMarkdownV1,
- [docSections.usage]: UsageMarkdown,
+ [markdownSections.introduction]: IntroMarkdownV1,
+ [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.usage]: UsageMarkdown,
},
},
- sections: docSections,
+ markdownSections: markdownSections,
typeConfigs: {
typeNameToExternalLink: {},
typeNameToPrefix: {},
diff --git a/packages/website/ts/containers/sol_cov_documentation.ts b/packages/website/ts/containers/sol_cov_documentation.ts
index 5567eb97e..0ad7bbfd4 100644
--- a/packages/website/ts/containers/sol_cov_documentation.ts
+++ b/packages/website/ts/containers/sol_cov_documentation.ts
@@ -14,15 +14,10 @@ const InstallationMarkdownV1 = require('md/docs/sol_cov/installation');
const UsageMarkdown = require('md/docs/sol_cov/usage');
/* tslint:enable:no-var-requires */
-const docSections = {
+const markdownSections = {
introduction: 'introduction',
installation: 'installation',
usage: 'usage',
- coverageSubprovider: 'coverageSubprovider',
- abstractArtifactAdapter: 'abstractArtifactAdapter',
- solCompilerArtifactAdapter: 'solCompilerArtifactAdapter',
- truffleArtifactAdapter: 'truffleArtifactAdapter',
- types: docConstants.TYPES_SECTION_NAME,
};
const docsInfoConfig: DocsInfoConfig = {
@@ -30,24 +25,19 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: 'Sol-cov',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
- introduction: [docSections.introduction],
- install: [docSections.installation],
- usage: [docSections.usage],
- 'coverage-subprovider': [docSections.coverageSubprovider],
- 'abstract-artifact-adapter': [docSections.abstractArtifactAdapter],
- 'sol-compiler-artifact-adapter': [docSections.solCompilerArtifactAdapter],
- 'truffle-artifact-adapter': [docSections.truffleArtifactAdapter],
- types: [docSections.types],
+ markdownMenu: {
+ introduction: [markdownSections.introduction],
+ install: [markdownSections.installation],
+ usage: [markdownSections.usage],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [docSections.introduction]: IntroMarkdownV1,
- [docSections.installation]: InstallationMarkdownV1,
- [docSections.usage]: UsageMarkdown,
+ [markdownSections.introduction]: IntroMarkdownV1,
+ [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.usage]: UsageMarkdown,
},
},
- sections: docSections,
+ markdownSections: markdownSections,
typeConfigs: {
typeNameToExternalLink: {},
typeNameToPrefix: {},
diff --git a/packages/website/ts/containers/subproviders_documentation.ts b/packages/website/ts/containers/subproviders_documentation.ts
index 76c71902e..4aaffd908 100644
--- a/packages/website/ts/containers/subproviders_documentation.ts
+++ b/packages/website/ts/containers/subproviders_documentation.ts
@@ -18,20 +18,7 @@ const LedgerNodeHidMarkdown = require('md/docs/subproviders/ledger_node_hid');
const docSections = {
introduction: 'introduction',
installation: 'installation',
- subprovider: 'subprovider',
- ledgerSubprovider: 'ledgerSubprovider',
ledgerNodeHid: 'ledger-node-hid-issue',
- factoryMethods: 'factory-methods',
- emptyWalletSubprovider: 'emptyWalletSubprovider',
- fakeGasEstimateSubprovider: 'fakeGasEstimateSubprovider',
- injectedWeb3Subprovider: 'injectedWeb3Subprovider',
- signerSubprovider: 'signerSubprovider',
- redundantRPCSubprovider: 'redundantRPCSubprovider',
- ganacheSubprovider: 'ganacheSubprovider',
- nonceTrackerSubprovider: 'nonceTrackerSubprovider',
- privateKeyWalletSubprovider: 'privateKeyWalletSubprovider',
- mnemonicWalletSubprovider: 'mnemonicWalletSubprovider',
- types: docConstants.TYPES_SECTION_NAME,
};
const docsInfoConfig: DocsInfoConfig = {
@@ -39,23 +26,10 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: 'Subproviders',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
+ markdownMenu: {
introduction: [docSections.introduction],
install: [docSections.installation],
- subprovider: [docSections.subprovider],
- ['ledger-subprovider']: [docSections.ledgerSubprovider],
['ledger-node-hid-issue']: [docSections.ledgerNodeHid],
- ['private-key-wallet-subprovider']: [docSections.privateKeyWalletSubprovider],
- ['mnemonic-wallet-subprovider']: [docSections.mnemonicWalletSubprovider],
- ['factory-methods']: [docSections.factoryMethods],
- ['emptyWallet-subprovider']: [docSections.emptyWalletSubprovider],
- ['fakeGasEstimate-subprovider']: [docSections.fakeGasEstimateSubprovider],
- ['injectedWeb3-subprovider']: [docSections.injectedWeb3Subprovider],
- ['signer-subprovider']: [docSections.signerSubprovider],
- ['redundantRPC-subprovider']: [docSections.redundantRPCSubprovider],
- ['ganache-subprovider']: [docSections.ganacheSubprovider],
- ['nonceTracker-subprovider']: [docSections.nonceTrackerSubprovider],
- types: [docSections.types],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
@@ -64,7 +38,7 @@ const docsInfoConfig: DocsInfoConfig = {
[docSections.ledgerNodeHid]: LedgerNodeHidMarkdown,
},
},
- sections: docSections,
+ markdownSections: docSections,
typeConfigs: {
typeNameToExternalLink: {
Web3: constants.URL_WEB3_DOCS,
diff --git a/packages/website/ts/containers/web3_wrapper_documentation.ts b/packages/website/ts/containers/web3_wrapper_documentation.ts
index 1a4101f5d..b015fd0d9 100644
--- a/packages/website/ts/containers/web3_wrapper_documentation.ts
+++ b/packages/website/ts/containers/web3_wrapper_documentation.ts
@@ -17,8 +17,6 @@ const InstallationMarkdownV1 = require('md/docs/web3_wrapper/installation');
const docSections = {
introduction: 'introduction',
installation: 'installation',
- web3Wrapper: 'web3Wrapper',
- types: docConstants.TYPES_SECTION_NAME,
};
const docsInfoConfig: DocsInfoConfig = {
@@ -26,11 +24,9 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: 'Web3Wrapper',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
+ markdownMenu: {
introduction: [docSections.introduction],
install: [docSections.installation],
- web3Wrapper: [docSections.web3Wrapper],
- types: [docSections.types],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
@@ -38,7 +34,7 @@ const docsInfoConfig: DocsInfoConfig = {
[docSections.installation]: InstallationMarkdownV1,
},
},
- sections: docSections,
+ markdownSections: docSections,
typeConfigs: {
typeNameToExternalLink: {
Web3: constants.URL_WEB3_DOCS,
diff --git a/packages/website/ts/containers/zero_ex_js_documentation.ts b/packages/website/ts/containers/zero_ex_js_documentation.ts
index 3b706f262..79e342e01 100644
--- a/packages/website/ts/containers/zero_ex_js_documentation.ts
+++ b/packages/website/ts/containers/zero_ex_js_documentation.ts
@@ -20,7 +20,7 @@ const IntroMarkdownV2 = require('md/docs/0xjs/2.0.0/introduction');
const versioningMarkdownV2 = require('md/docs/0xjs/2.0.0/versioning');
/* tslint:enable:no-var-requires */
-const zeroExJsDocSections = {
+const markdownSections = {
introduction: 'introduction',
installation: 'installation',
testrpc: 'testrpc',
@@ -34,29 +34,29 @@ const docsInfoConfig: DocsInfoConfig = {
type: SupportedDocJson.TypeDoc,
displayName: '0x.js',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
- menu: {
- introduction: [zeroExJsDocSections.introduction],
- install: [zeroExJsDocSections.installation],
- topics: [zeroExJsDocSections.async, zeroExJsDocSections.errors, zeroExJsDocSections.versioning],
+ markdownMenu: {
+ introduction: [markdownSections.introduction],
+ install: [markdownSections.installation],
+ topics: [markdownSections.async, markdownSections.errors, markdownSections.versioning],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
- [zeroExJsDocSections.introduction]: IntroMarkdownV1,
- [zeroExJsDocSections.installation]: InstallationMarkdownV1,
- [zeroExJsDocSections.async]: AsyncMarkdownV1,
- [zeroExJsDocSections.errors]: ErrorsMarkdownV1,
- [zeroExJsDocSections.versioning]: versioningMarkdownV1,
+ [markdownSections.introduction]: IntroMarkdownV1,
+ [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.async]: AsyncMarkdownV1,
+ [markdownSections.errors]: ErrorsMarkdownV1,
+ [markdownSections.versioning]: versioningMarkdownV1,
},
'1.0.0-rc.1': {
- [zeroExJsDocSections.introduction]: IntroMarkdownV2,
- [zeroExJsDocSections.versioning]: versioningMarkdownV2,
+ [markdownSections.introduction]: IntroMarkdownV2,
+ [markdownSections.versioning]: versioningMarkdownV2,
// These are the same as for V1
- [zeroExJsDocSections.installation]: InstallationMarkdownV1,
- [zeroExJsDocSections.async]: AsyncMarkdownV1,
- [zeroExJsDocSections.errors]: ErrorsMarkdownV1,
+ [markdownSections.installation]: InstallationMarkdownV1,
+ [markdownSections.async]: AsyncMarkdownV1,
+ [markdownSections.errors]: ErrorsMarkdownV1,
},
},
- sections: zeroExJsDocSections,
+ markdownSections: markdownSections,
typeConfigs: {
typeNameToPrefix: {},
typeNameToExternalLink: {