crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

0xjs README/website docs update

Browse Source
This commit is contained in:
Jacob Evans
2018-09-13 13:51:09 +02:00
parent df5779b6d1
commit cf46d2c704
13 changed files with 111 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
packages/website/ts/containers/zero_ex_js_documentation.ts
View File

@@ -9,14 +9,15 @@ import { DocPackages } from 'ts/types';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
const IntroMarkdownV1 = require('md/docs/0xjs/1.0.0/introduction');
const InstallationMarkdownV1 = require('md/docs/0xjs/1.0.0/installation');
const AsyncMarkdownV1 = require('md/docs/0xjs/1.0.0/async');
const ErrorsMarkdownV1 = require('md/docs/0xjs/1.0.0/errors');
const versioningMarkdownV1 = require('md/docs/0xjs/1.0.0/versioning');
const IntroMarkdownV1 = require('md/docs/0xjs/0.0.1/introduction');
const InstallationMarkdownV1 = require('md/docs/0xjs/0.0.1/installation');
const AsyncMarkdownV1 = require('md/docs/0xjs/0.0.1/async');
const ErrorsMarkdownV1 = require('md/docs/0xjs/0.0.1/errors');
const versioningMarkdownV1 = require('md/docs/0xjs/0.0.1/versioning');
const IntroMarkdownV2 = require('md/docs/0xjs/1.0.0/introduction');
const versioningMarkdownV2 = require('md/docs/0xjs/1.0.0/versioning');
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 markdownSections = {
@@ -28,6 +29,12 @@ const markdownSections = {
versioning: 'versioning',
};
const sharedMarkdownSections = {
[markdownSections.installation]: InstallationMarkdownV1,
[markdownSections.async]: AsyncMarkdownV1,
[markdownSections.errors]: ErrorsMarkdownV1,
};
const docsInfoConfig: DocsInfoConfig = {
id: DocPackages.ZeroExJs,
packageName: '0x.js',
@@ -42,18 +49,14 @@ const docsInfoConfig: DocsInfoConfig = {
sectionNameToMarkdownByVersion: {
'0.0.1': {
[markdownSections.introduction]: IntroMarkdownV1,
[markdownSections.installation]: InstallationMarkdownV1,
[markdownSections.async]: AsyncMarkdownV1,
[markdownSections.errors]: ErrorsMarkdownV1,
[markdownSections.versioning]: versioningMarkdownV1,
...sharedMarkdownSections,
},
'1.0.0-rc.1': {
'1.0.1': {
[markdownSections.introduction]: IntroMarkdownV2,
[markdownSections.versioning]: versioningMarkdownV2,
// These are the same as for V1
[markdownSections.installation]: InstallationMarkdownV1,
[markdownSections.async]: AsyncMarkdownV1,
[markdownSections.errors]: ErrorsMarkdownV1,
...sharedMarkdownSections,
},
},
markdownSections,