aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJacob Evans <jacob@dekz.net>2018-09-13 20:22:33 +0800
committerJacob Evans <jacob@dekz.net>2018-09-13 20:32:46 +0800
commit3d1b7c10e8fe748f9105914e4a6ec82e45467034 (patch)
tree5992d408a10baec6125ca75dd1cab2770d2f5139
parentcf46d2c7049461e25441239e71f486bfbd2a986a (diff)
downloaddexon-sol-tools-3d1b7c10e8fe748f9105914e4a6ec82e45467034.tar.gz
dexon-sol-tools-3d1b7c10e8fe748f9105914e4a6ec82e45467034.tar.zst
dexon-sol-tools-3d1b7c10e8fe748f9105914e4a6ec82e45467034.zip
Remove note about RC versions
-rw-r--r--packages/website/md/docs/0xjs/1.0.0/async.md2
-rw-r--r--packages/website/md/docs/0xjs/1.0.0/introduction.md2
-rw-r--r--packages/website/ts/containers/zero_ex_js_documentation.ts20
3 files changed, 11 insertions, 13 deletions
diff --git a/packages/website/md/docs/0xjs/1.0.0/async.md b/packages/website/md/docs/0xjs/1.0.0/async.md
index 2909e47e0..bd5ae9d8a 100644
--- a/packages/website/md/docs/0xjs/1.0.0/async.md
+++ b/packages/website/md/docs/0xjs/1.0.0/async.md
@@ -18,7 +18,7 @@ try {
_Promise syntax:_
```javascript
-signature = signatureUtils
+signatureUtils
.ecSignOrderHashAsync(providerEngine, orderHashHex, maker, SignerType.Default)
.then(function(signature) {
console.log(signature);
diff --git a/packages/website/md/docs/0xjs/1.0.0/introduction.md b/packages/website/md/docs/0xjs/1.0.0/introduction.md
index d228c6855..4d5d314d3 100644
--- a/packages/website/md/docs/0xjs/1.0.0/introduction.md
+++ b/packages/website/md/docs/0xjs/1.0.0/introduction.md
@@ -1,3 +1 @@
-<b>**NOTE:** Release candidate versions are meant to work with V2 of 0x protocol. To interact with V1, select a 0.X version.</b>
-
Welcome to the [0x.js](https://github.com/0xProject/0x-monorepo/tree/development/packages/0x.js) documentation! 0x.js is a Javascript library for interacting with the 0x protocol. With it, you can easily make calls to the 0x smart contracts as well as any token adhering to the token standards supported by the protocol (currently ERC20 & ERC721). Functionality includes generating, signing, filling and cancelling orders, verifying an orders signature, setting or checking a users ERC20/ERC721 token balance/allowance and much more.
diff --git a/packages/website/ts/containers/zero_ex_js_documentation.ts b/packages/website/ts/containers/zero_ex_js_documentation.ts
index 51820d620..7d48e039c 100644
--- a/packages/website/ts/containers/zero_ex_js_documentation.ts
+++ b/packages/website/ts/containers/zero_ex_js_documentation.ts
@@ -16,6 +16,9 @@ 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 InstallationMarkdownV2 = require('md/docs/0xjs/1.0.0/installation');
+const AsyncMarkdownV2 = require('md/docs/0xjs/1.0.0/async');
+const ErrorsMarkdownV2 = ErrorsMarkdownV1;
const versioningMarkdownV2 = require('md/docs/0xjs/1.0.0/versioning');
/* tslint:enable:no-var-requires */
@@ -29,12 +32,6 @@ const markdownSections = {
versioning: 'versioning',
};
-const sharedMarkdownSections = {
- [markdownSections.installation]: InstallationMarkdownV1,
- [markdownSections.async]: AsyncMarkdownV1,
- [markdownSections.errors]: ErrorsMarkdownV1,
-};
-
const docsInfoConfig: DocsInfoConfig = {
id: DocPackages.ZeroExJs,
packageName: '0x.js',
@@ -49,14 +46,17 @@ const docsInfoConfig: DocsInfoConfig = {
sectionNameToMarkdownByVersion: {
'0.0.1': {
[markdownSections.introduction]: IntroMarkdownV1,
+ [markdownSections.installation]: InstallationMarkdownV1,
[markdownSections.versioning]: versioningMarkdownV1,
- ...sharedMarkdownSections,
+ [markdownSections.async]: AsyncMarkdownV1,
+ [markdownSections.errors]: ErrorsMarkdownV1,
},
- '1.0.1': {
+ '1.0.0': {
[markdownSections.introduction]: IntroMarkdownV2,
+ [markdownSections.installation]: InstallationMarkdownV2,
[markdownSections.versioning]: versioningMarkdownV2,
- // These are the same as for V1
- ...sharedMarkdownSections,
+ [markdownSections.async]: AsyncMarkdownV2,
+ [markdownSections.errors]: ErrorsMarkdownV2,
},
},
markdownSections,