Merge pull request #519 from 0xProject/fix/docImprovements

Doc fixes and improvements

4 files changed, 38 insertions, 29 deletions

diff --git a/packages/website/ts/containers/sol_cov_documentation.ts b/packages/website/ts/containers/sol_cov_documentation.ts
index 2b901ec6f..58755c1e0 100644
--- a/packages/website/ts/containers/sol_cov_documentation.ts
+++ b/packages/website/ts/containers/sol_cov_documentation.ts
@@ -44,7 +44,7 @@ const docsInfoConfig: DocsInfoConfig = {
     },
     sectionNameToModulePath: {
         [docSections.coverageSubprovider]: ['"sol-cov/src/coverage_subprovider"'],
-        [docSections.types]: ['"subproviders/src/types"'],
+        [docSections.types]: ['"subproviders/src/types"', '"types/src/index"'],
     },
     menuSubsectionToVersionWhenIntroduced: {},
     sections: docSections,
@@ -52,11 +52,9 @@ const docsInfoConfig: DocsInfoConfig = {
     typeConfigs: {
         // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is
         // currently no way to extract the re-exported types from index.ts via TypeDoc :(
-        publicTypes: ['NextCallback', 'OnNextCompleted', 'ErrorCallback'],
+        publicTypes: ['NextCallback', 'OnNextCompleted', 'ErrorCallback', 'JSONRPCRequestPayload'],
         typeNameToExternalLink: {},
-        typeNameToPrefix: {
-            JSONRPCRequestPayload: 'Web3',
-        },
+        typeNameToPrefix: {},
         typeNameToDocSection: {},
     },
 };
diff --git a/packages/website/ts/containers/subproviders_documentation.ts b/packages/website/ts/containers/subproviders_documentation.ts
index 7aa05f9a5..4a956acea 100644
--- a/packages/website/ts/containers/subproviders_documentation.ts
+++ b/packages/website/ts/containers/subproviders_documentation.ts
@@ -91,25 +91,21 @@ const docsInfoConfig: DocsInfoConfig = {
             'ErrorCallback',
             'ECSignature',
             'JSONRPCRequestPayloadWithMethod',
+            'JSONRPCRequestPayload',
             'JSONRPCResponsePayload',
             'AccountFetchingConfigs',
             'LedgerEthereumClientFactoryAsync',
             'PartialTxParams',
             'LedgerEthereumClient',
             'LedgerSubproviderConfigs',
+            'OnNextCompleted',
+            'Provider',
         ],
         typeNameToExternalLink: {
             Web3: 'https://github.com/ethereum/wiki/wiki/JavaScript-API',
             BigNumber: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L127',
-            JSONRPCRequestPayload: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L137',
-            JSONRPCResponsePayload: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L144',
-            Provider: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L150',
-        },
-        typeNameToPrefix: {
-            JSONRPCRequestPayload: 'Web3',
-            JSONRPCResponsePayload: 'Web3',
-            Provider: 'Web3',
         },
+        typeNameToPrefix: {},
     },
 };
 const docsInfo = new DocsInfo(docsInfoConfig);
diff --git a/packages/website/ts/containers/web3_wrapper_documentation.ts b/packages/website/ts/containers/web3_wrapper_documentation.ts
index b0adad536..9c0ca9b9a 100644
--- a/packages/website/ts/containers/web3_wrapper_documentation.ts
+++ b/packages/website/ts/containers/web3_wrapper_documentation.ts
@@ -59,15 +59,36 @@ const docsInfoConfig: DocsInfoConfig = {
             'BlockWithoutTransactionData',
             'CallData',
             'LogEntryEvent',
+            'Provider',
+            'AbiDefinition',
+            'LogTopic',
+            'JSONRPCRequestPayload',
+            'JSONRPCResponsePayload',
+            'BlockParamLiteral',
+            'FunctionAbi',
+            'EventAbi',
+            'JSONRPCErrorCallback',
+            'MethodAbi',
+            'ConstructorAbi',
+            'FallbackAbi',
+            'EventParameter',
+            'DataItem',
+            'StateMutability',
+            'Function',
+            'Fallback',
+            'Constructor',
+            'Event',
+            'ConstructorStateMutability',
+            'TransactionReceiptWithDecodedLogs',
+            'DecodedLogArgs',
+            'LogWithDecodedArgs',
+            'ContractEventArg',
         ],
         typeNameToExternalLink: {
             Web3: 'https://github.com/ethereum/wiki/wiki/JavaScript-API',
-            Provider: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L150',
             BigNumber: 'http://mikemcl.github.io/bignumber.js',
         },
-        typeNameToPrefix: {
-            Provider: 'Web3',
-        },
+        typeNameToPrefix: {},
         typeNameToDocSection: {
             Web3Wrapper: docSections.web3Wrapper,
         },
diff --git a/packages/website/ts/containers/zero_ex_js_documentation.ts b/packages/website/ts/containers/zero_ex_js_documentation.ts
index da8922e79..40853cb9e 100644
--- a/packages/website/ts/containers/zero_ex_js_documentation.ts
+++ b/packages/website/ts/containers/zero_ex_js_documentation.ts
@@ -168,21 +168,15 @@ const docsInfoConfig: DocsInfoConfig = {
             'OrderStateWatcherConfig',
             'FilterObject',
             'OrderRelevantState',
+            'JSONRPCRequestPayload',
+            'JSONRPCResponsePayload',
+            'JSONRPCErrorCallback',
+            'LogEntryEvent',
+            'LogEntry',
         ],
-        typeNameToPrefix: {
-            Provider: 'Web3',
-            DecodedLogEntryEvent: 'Web3',
-            LogEntryEvent: 'Web3',
-            CallData: 'Web3',
-            LogEntry: 'Web3',
-        },
+        typeNameToPrefix: {},
         typeNameToExternalLink: {
-            Web3: constants.URL_WEB3_DOCS,
-            Provider: constants.URL_WEB3_PROVIDER_DOCS,
             BigNumber: constants.URL_BIGNUMBERJS_GITHUB,
-            DecodedLogEntryEvent: constants.URL_WEB3_DECODED_LOG_ENTRY_EVENT,
-            LogEntryEvent: constants.URL_WEB3_LOG_ENTRY_EVENT,
-            LogEntry: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L366',
         },
         typeNameToDocSection: {
             ExchangeWrapper: 'exchange',