From 629a0fa3a562a9df00eeeb5ce5b1bad853008ac3 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Tue, 28 Nov 2017 15:42:27 -0600 Subject: Add subPackageName and get rid of hard-coded 0x.js in sourceLink --- packages/website/ts/containers/zero_ex_js_documentation.tsx | 1 + packages/website/ts/pages/documentation/docs_info.ts | 2 ++ packages/website/ts/pages/documentation/documentation.tsx | 1 + packages/website/ts/pages/documentation/method_block.tsx | 1 + packages/website/ts/pages/documentation/source_link.tsx | 13 +++++++++++-- packages/website/ts/types.ts | 1 + 6 files changed, 17 insertions(+), 2 deletions(-) diff --git a/packages/website/ts/containers/zero_ex_js_documentation.tsx b/packages/website/ts/containers/zero_ex_js_documentation.tsx index 15a137de1..cbb8fce5f 100644 --- a/packages/website/ts/containers/zero_ex_js_documentation.tsx +++ b/packages/website/ts/containers/zero_ex_js_documentation.tsx @@ -41,6 +41,7 @@ const zeroExJsDocSections = { const docsInfoConfig: DocsInfoConfig = { packageName: '0x.js', packageUrl: 'https://github.com/0xProject/0x.js', + subPackageName: '0x.js', websitePath: WebsitePaths.ZeroExJs, docsJsonRoot: 'https://s3.amazonaws.com/0xjs-docs-jsons', menu: { diff --git a/packages/website/ts/pages/documentation/docs_info.ts b/packages/website/ts/pages/documentation/docs_info.ts index f607c2185..fd8e9df74 100644 --- a/packages/website/ts/pages/documentation/docs_info.ts +++ b/packages/website/ts/pages/documentation/docs_info.ts @@ -13,6 +13,7 @@ import { export class DocsInfo { public packageName: string; public packageUrl: string; + public subPackageName?: string; public websitePath: string; public docsJsonRoot: string; public menu: DocsMenu; @@ -22,6 +23,7 @@ export class DocsInfo { constructor(config: DocsInfoConfig) { this.packageName = config.packageName; this.packageUrl = config.packageUrl; + this.subPackageName = config.subPackageName; this.websitePath = config.websitePath; this.docsJsonRoot = config.docsJsonRoot; this.sections = config.sections; diff --git a/packages/website/ts/pages/documentation/documentation.tsx b/packages/website/ts/pages/documentation/documentation.tsx index 288a8f79c..b56441bfe 100644 --- a/packages/website/ts/pages/documentation/documentation.tsx +++ b/packages/website/ts/pages/documentation/documentation.tsx @@ -335,6 +335,7 @@ export class Documentation extends version={this.props.docsVersion} source={property.source} baseUrl={this.props.docsInfo.packageUrl} + subPackageName={this.props.docsInfo.subPackageName} /> } {property.comment && diff --git a/packages/website/ts/pages/documentation/method_block.tsx b/packages/website/ts/pages/documentation/method_block.tsx index 3f4eb7164..44e549211 100644 --- a/packages/website/ts/pages/documentation/method_block.tsx +++ b/packages/website/ts/pages/documentation/method_block.tsx @@ -95,6 +95,7 @@ export class MethodBlock extends React.Component } {method.comment && diff --git a/packages/website/ts/pages/documentation/source_link.tsx b/packages/website/ts/pages/documentation/source_link.tsx index 408dcabc7..74fc6d4d5 100644 --- a/packages/website/ts/pages/documentation/source_link.tsx +++ b/packages/website/ts/pages/documentation/source_link.tsx @@ -1,3 +1,4 @@ +import * as _ from 'lodash'; import {colors} from 'material-ui/styles'; import * as React from 'react'; import {Source} from 'ts/types'; @@ -7,14 +8,22 @@ interface SourceLinkProps { source: Source; baseUrl: string; version: string; + subPackageName: string; } -const SUB_PKG = '0x.js'; +const packagesWithNamespace = [ + 'connect', +]; export function SourceLink(props: SourceLinkProps) { const src = props.source; const url = props.baseUrl; - const sourceCodeUrl = `${url}/blob/${SUB_PKG}%40${props.version}/packages/${SUB_PKG}/${src.fileName}#L${src.line}`; + const pkg = props.subPackageName; + let tagPrefix = pkg; + if (_.includes(packagesWithNamespace, pkg)) { + tagPrefix = `@0xproject/${pkg}`; + } + const sourceCodeUrl = `${url}/blob/${tagPrefix}%40${props.version}/packages/${pkg}/${src.fileName}#L${src.line}`; return (
DocAgnosticFormat; + subPackageName?: string; publicTypes?: string[]; sectionNameToModulePath?: {[sectionName: string]: string[]}; menuSubsectionToVersionWhenIntroduced?: {[sectionName: string]: string}; -- cgit v1.2.3 From 166c741beb569ea5245a47203edaef4c9232b8d4 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Tue, 28 Nov 2017 15:42:37 -0600 Subject: Add connect docs --- .../ts/containers/connect_documentation.tsx | 97 ++++++++++++++++++++++ packages/website/ts/index.tsx | 7 ++ packages/website/ts/types.ts | 1 + 3 files changed, 105 insertions(+) create mode 100644 packages/website/ts/containers/connect_documentation.tsx diff --git a/packages/website/ts/containers/connect_documentation.tsx b/packages/website/ts/containers/connect_documentation.tsx new file mode 100644 index 000000000..f6ae53a30 --- /dev/null +++ b/packages/website/ts/containers/connect_documentation.tsx @@ -0,0 +1,97 @@ +import BigNumber from 'bignumber.js'; +import * as _ from 'lodash'; +import * as React from 'react'; +import {connect} from 'react-redux'; +import {Dispatch, Store as ReduxStore} from 'redux'; +import {Blockchain} from 'ts/blockchain'; +import {DocsInfo} from 'ts/pages/documentation/docs_info'; +import { + Documentation as DocumentationComponent, + DocumentationAllProps, +} from 'ts/pages/documentation/documentation'; +import {Dispatcher} from 'ts/redux/dispatcher'; +import {State} from 'ts/redux/reducer'; +import {DocsInfoConfig, WebsitePaths} from 'ts/types'; +import {typeDocUtils} from 'ts/utils/typedoc_utils'; + +/* tslint:disable:no-var-requires */ +const IntroMarkdown = require('md/docs/connect/introduction'); +const InstallationMarkdown = require('md/docs/connect/installation'); +/* tslint:enable:no-var-requires */ + +const connectDocSections = { + introduction: 'introduction', + installation: 'installation', + httpClient: 'httpClient', + types: 'types', +}; + +const docsInfoConfig: DocsInfoConfig = { + packageName: '0x Connect', + subPackageName: 'connect', + packageUrl: 'https://github.com/0xProject/0x.js', + websitePath: WebsitePaths.Connect, + docsJsonRoot: 'https://s3.amazonaws.com/connect-docs-jsons', + menu: { + introduction: [ + connectDocSections.introduction, + ], + install: [ + connectDocSections.installation, + ], + httpClient: [ + connectDocSections.httpClient, + ], + types: [ + connectDocSections.types, + ], + }, + sectionNameToMarkdown: { + [connectDocSections.introduction]: IntroMarkdown, + [connectDocSections.installation]: InstallationMarkdown, + }, + // 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: [ + 'Client', + 'FeesRequest', + 'FeesResponse', + 'OrderbookRequest', + 'OrderbookResponse', + 'OrdersRequest', + 'TokenPairsItem', + 'TokenPairsRequest', + ], + sectionNameToModulePath: { + [connectDocSections.httpClient]: ['"src/http_client"'], + [connectDocSections.types]: ['"src/types"'], + }, + menuSubsectionToVersionWhenIntroduced: {}, + sections: connectDocSections, + visibleConstructors: [connectDocSections.httpClient], + convertToDocAgnosticFormatFn: typeDocUtils.convertToDocAgnosticFormat.bind(typeDocUtils), +}; +const docsInfo = new DocsInfo(docsInfoConfig); + +interface ConnectedState { + docsVersion: string; + availableDocVersions: string[]; + docsInfo: DocsInfo; +} + +interface ConnectedDispatch { + dispatcher: Dispatcher; +} + +const mapStateToProps = (state: State, ownProps: DocumentationAllProps): ConnectedState => ({ + docsVersion: state.docsVersion, + availableDocVersions: state.availableDocVersions, + docsInfo, +}); + +const mapDispatchToProps = (dispatch: Dispatch): ConnectedDispatch => ({ + dispatcher: new Dispatcher(dispatch), +}); + +export const Documentation: React.ComponentClass = + connect(mapStateToProps, mapDispatchToProps)(DocumentationComponent); diff --git a/packages/website/ts/index.tsx b/packages/website/ts/index.tsx index 8b6d4d956..283eb8125 100644 --- a/packages/website/ts/index.tsx +++ b/packages/website/ts/index.tsx @@ -87,6 +87,12 @@ const LazySmartContractsDocumentation = createLazyComponent( /* webpackChunkName: "smartContractDocs" */'ts/containers/smart_contracts_documentation', ), ); +const LazyConnectDocumentation = createLazyComponent( + 'Documentation', + async () => System.import( + /* webpackChunkName: "connectDocs" */'ts/containers/connect_documentation', + ), +); const docs = class Documentation extends React.Component { @@ -112,6 +118,7 @@ render( + Date: Tue, 28 Nov 2017 16:02:31 -0600 Subject: Add 0x Connect Docs to the menu and topBar --- packages/website/ts/components/top_bar.tsx | 26 +++++++++++++++++----- .../ts/pages/documentation/documentation.tsx | 2 +- 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/packages/website/ts/components/top_bar.tsx b/packages/website/ts/components/top_bar.tsx index 7b81253e2..79abd5356 100644 --- a/packages/website/ts/components/top_bar.tsx +++ b/packages/website/ts/components/top_bar.tsx @@ -34,7 +34,7 @@ interface TopBarProps { menu?: DocsMenu; menuSubsectionsBySection?: MenuSubsectionsBySection; shouldFullWidth?: boolean; - docPath?: string; + docsInfo?: DocsInfo; style?: React.CSSProperties; isNightVersion?: boolean; } @@ -111,6 +111,13 @@ export class TopBar extends React.Component { > , + + + , { 0x.js Docs } + {!this.isViewingConnectDocs() && + + 0x Connect Docs + + } {!this.isViewingSmartContractsDocs() && Smart Contract Docs @@ -274,11 +286,12 @@ export class TopBar extends React.Component { ); } private renderDocsMenu() { - if (!this.isViewing0xjsDocs() && !this.isViewingSmartContractsDocs() || _.isUndefined(this.props.menu)) { + if (!this.isViewing0xjsDocs() && !this.isViewingSmartContractsDocs() && !this.isViewingConnectDocs() + || _.isUndefined(this.props.menu)) { return; } - const sectionTitle = this.isViewing0xjsDocs() ? '0x.js Docs' : 'Smart contract Docs'; + const sectionTitle = `${this.props.docsInfo.packageName} Docs`; return (
{sectionTitle}
@@ -288,7 +301,7 @@ export class TopBar extends React.Component { shouldDisplaySectionHeaders={false} onMenuItemClick={this.onMenuButtonClick.bind(this)} selectedVersion={this.props.docsVersion} - docPath={this.props.docPath} + docPath={this.props.docsInfo.websitePath} versions={this.props.availableDocVersions} />
@@ -362,6 +375,9 @@ export class TopBar extends React.Component { private isViewing0xjsDocs() { return _.includes(this.props.location.pathname, WebsitePaths.ZeroExJs); } + private isViewingConnectDocs() { + return _.includes(this.props.location.pathname, WebsitePaths.Connect); + } private isViewingSmartContractsDocs() { return _.includes(this.props.location.pathname, WebsitePaths.SmartContracts); } @@ -370,6 +386,6 @@ export class TopBar extends React.Component { } private shouldDisplayBottomBar() { return this.isViewingWiki() || this.isViewing0xjsDocs() || this.isViewingFAQ() || - this.isViewingSmartContractsDocs(); + this.isViewingSmartContractsDocs() || this.isViewingConnectDocs(); } } diff --git a/packages/website/ts/pages/documentation/documentation.tsx b/packages/website/ts/pages/documentation/documentation.tsx index b56441bfe..27cd1da2c 100644 --- a/packages/website/ts/pages/documentation/documentation.tsx +++ b/packages/website/ts/pages/documentation/documentation.tsx @@ -120,7 +120,7 @@ export class Documentation extends menu={this.props.docsInfo.getMenu(this.props.docsVersion)} menuSubsectionsBySection={menuSubsectionsBySection} shouldFullWidth={true} - docPath={this.props.docsInfo.websitePath} + docsInfo={this.props.docsInfo} /> {_.isUndefined(this.state.docAgnosticFormat) ?
Date: Tue, 28 Nov 2017 16:22:18 -0600 Subject: Lock the 0x.js version used in website --- packages/website/package.json | 2 +- yarn.lock | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/packages/website/package.json b/packages/website/package.json index eb6a5df35..9b0d8a807 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -18,7 +18,7 @@ "author": "Fabio Berger", "license": "Apache-2.0", "dependencies": { - "0x.js": "^0.27.1", + "0x.js": "0xproject/0x.js/packages/0x.js#0x.js@0.27.0", "accounting": "^0.4.1", "basscss": "^8.0.3", "bignumber.js": "~4.1.0", diff --git a/yarn.lock b/yarn.lock index 22aed2ce3..0697b59af 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2,6 +2,26 @@ # yarn lockfile v1 +"0x.js@0xproject/0x.js/packages/0x.js#0x.js@0.27.0": + version "0.27.1" + resolved "https://registry.yarnpkg.com/0x.js/-/0x.js-0.27.1.tgz#e0dff70e257efbb7f54dddb55dddf2dce0b971ab" + dependencies: + "@0xproject/assert" "^0.0.6" + "@0xproject/json-schemas" "^0.6.9" + bignumber.js "~4.1.0" + bintrees "^1.0.2" + bn.js "4.11.8" + compare-versions "^3.0.1" + es6-promisify "^5.0.0" + ethereumjs-abi "^0.6.4" + ethereumjs-blockstream "^2.0.6" + ethereumjs-util "^5.1.1" + find-versions "^2.0.0" + js-sha3 "^0.6.1" + lodash "^4.17.4" + uuid "^3.1.0" + web3 "^0.20.0" + "@types/accounting@^0.4.1": version "0.4.1" resolved "https://registry.yarnpkg.com/@types/accounting/-/accounting-0.4.1.tgz#865d9f5694fd7c438fba34eb4bc82eec6f34cdd5" -- cgit v1.2.3 From 46f185bbebbe4c14bfbd9ca7c3f8a9735d643aba Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 29 Nov 2017 08:30:31 -0600 Subject: Update 0x.js to 0.27.1 --- packages/website/package.json | 2 +- yarn.lock | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/website/package.json b/packages/website/package.json index 9b0d8a807..8cde4b8e1 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -18,7 +18,7 @@ "author": "Fabio Berger", "license": "Apache-2.0", "dependencies": { - "0x.js": "0xproject/0x.js/packages/0x.js#0x.js@0.27.0", + "0x.js": "0xproject/0x.js/packages/0x.js#0x.js@0.27.1", "accounting": "^0.4.1", "basscss": "^8.0.3", "bignumber.js": "~4.1.0", diff --git a/yarn.lock b/yarn.lock index 0697b59af..53bf63887 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2,7 +2,7 @@ # yarn lockfile v1 -"0x.js@0xproject/0x.js/packages/0x.js#0x.js@0.27.0": +"0x.js@0xproject/0x.js/packages/0x.js#0x.js@0.27.1": version "0.27.1" resolved "https://registry.yarnpkg.com/0x.js/-/0x.js-0.27.1.tgz#e0dff70e257efbb7f54dddb55dddf2dce0b971ab" dependencies: -- cgit v1.2.3 From 6093ee78241c42b66be95bf8bfff28d48bf41d45 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 29 Nov 2017 08:47:55 -0600 Subject: Add 0x Connect to footer --- packages/website/ts/components/footer.tsx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/website/ts/components/footer.tsx b/packages/website/ts/components/footer.tsx index f7070e0f8..5e3c0479a 100644 --- a/packages/website/ts/components/footer.tsx +++ b/packages/website/ts/components/footer.tsx @@ -41,6 +41,10 @@ const menuItemsBySection: MenuItemsBySection = { title: '0x Smart Contracts', path: WebsitePaths.SmartContracts, }, + { + title: '0x Connect', + path: WebsitePaths.Connect, + }, { title: 'Whitepaper', path: WebsitePaths.Whitepaper, -- cgit v1.2.3 From 0e856ccfab98fc2f9c105efca91b09adef6c3da0 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 29 Nov 2017 08:48:11 -0600 Subject: Fix phantom `Contracts` section issue --- packages/website/ts/pages/documentation/docs_info.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/website/ts/pages/documentation/docs_info.ts b/packages/website/ts/pages/documentation/docs_info.ts index fd8e9df74..7fe5d9b31 100644 --- a/packages/website/ts/pages/documentation/docs_info.ts +++ b/packages/website/ts/pages/documentation/docs_info.ts @@ -47,6 +47,11 @@ export class DocsInfo { } const finalMenu = _.cloneDeep(this.docsInfo.menu); + if (_.isUndefined(finalMenu.contracts)) { + return finalMenu; + } + + // TODO: refactor to include more sections then simply the `contracts` section finalMenu.contracts = _.filter(finalMenu.contracts, (contractName: string) => { const versionIntroducedIfExists = this.docsInfo.menuSubsectionToVersionWhenIntroduced[contractName]; if (!_.isUndefined(versionIntroducedIfExists)) { -- cgit v1.2.3 From 53522a98b99d27ecfc4c782ca43e0f002050d6ee Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 29 Nov 2017 08:52:49 -0600 Subject: Rename packageName to displayName for clarity --- packages/website/ts/components/top_bar.tsx | 2 +- packages/website/ts/containers/connect_documentation.tsx | 2 +- packages/website/ts/containers/smart_contracts_documentation.tsx | 2 +- packages/website/ts/containers/zero_ex_js_documentation.tsx | 2 +- packages/website/ts/pages/documentation/docs_info.ts | 4 ++-- packages/website/ts/pages/documentation/documentation.tsx | 4 ++-- packages/website/ts/types.ts | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/website/ts/components/top_bar.tsx b/packages/website/ts/components/top_bar.tsx index 79abd5356..4398fe667 100644 --- a/packages/website/ts/components/top_bar.tsx +++ b/packages/website/ts/components/top_bar.tsx @@ -291,7 +291,7 @@ export class TopBar extends React.Component { return; } - const sectionTitle = `${this.props.docsInfo.packageName} Docs`; + const sectionTitle = `${this.props.docsInfo.displayName} Docs`; return (
{sectionTitle}
diff --git a/packages/website/ts/containers/connect_documentation.tsx b/packages/website/ts/containers/connect_documentation.tsx index f6ae53a30..3575538e1 100644 --- a/packages/website/ts/containers/connect_documentation.tsx +++ b/packages/website/ts/containers/connect_documentation.tsx @@ -27,7 +27,7 @@ const connectDocSections = { }; const docsInfoConfig: DocsInfoConfig = { - packageName: '0x Connect', + displayName: '0x Connect', subPackageName: 'connect', packageUrl: 'https://github.com/0xProject/0x.js', websitePath: WebsitePaths.Connect, diff --git a/packages/website/ts/containers/smart_contracts_documentation.tsx b/packages/website/ts/containers/smart_contracts_documentation.tsx index 4623c976b..ea2b19b8c 100644 --- a/packages/website/ts/containers/smart_contracts_documentation.tsx +++ b/packages/website/ts/containers/smart_contracts_documentation.tsx @@ -20,7 +20,7 @@ const IntroMarkdown = require('md/docs/smart_contracts/introduction'); const sections = constants.smartContractDocSections; const docsInfoConfig: DocsInfoConfig = { - packageName: '0x Smart Contracts', + displayName: '0x Smart Contracts', packageUrl: 'https://github.com/0xProject/contracts', websitePath: WebsitePaths.SmartContracts, docsJsonRoot: 'https://s3.amazonaws.com/smart-contracts-docs-json', diff --git a/packages/website/ts/containers/zero_ex_js_documentation.tsx b/packages/website/ts/containers/zero_ex_js_documentation.tsx index cbb8fce5f..fc48297b5 100644 --- a/packages/website/ts/containers/zero_ex_js_documentation.tsx +++ b/packages/website/ts/containers/zero_ex_js_documentation.tsx @@ -39,7 +39,7 @@ const zeroExJsDocSections = { }; const docsInfoConfig: DocsInfoConfig = { - packageName: '0x.js', + displayName: '0x.js', packageUrl: 'https://github.com/0xProject/0x.js', subPackageName: '0x.js', websitePath: WebsitePaths.ZeroExJs, diff --git a/packages/website/ts/pages/documentation/docs_info.ts b/packages/website/ts/pages/documentation/docs_info.ts index 7fe5d9b31..1afcf8aaf 100644 --- a/packages/website/ts/pages/documentation/docs_info.ts +++ b/packages/website/ts/pages/documentation/docs_info.ts @@ -11,7 +11,7 @@ import { } from 'ts/types'; export class DocsInfo { - public packageName: string; + public displayName: string; public packageUrl: string; public subPackageName?: string; public websitePath: string; @@ -21,7 +21,7 @@ export class DocsInfo { public sectionNameToMarkdown: {[sectionName: string]: string}; private docsInfo: DocsInfoConfig; constructor(config: DocsInfoConfig) { - this.packageName = config.packageName; + this.displayName = config.displayName; this.packageUrl = config.packageUrl; this.subPackageName = config.subPackageName; this.websitePath = config.websitePath; diff --git a/packages/website/ts/pages/documentation/documentation.tsx b/packages/website/ts/pages/documentation/documentation.tsx index 27cd1da2c..be99e77a2 100644 --- a/packages/website/ts/pages/documentation/documentation.tsx +++ b/packages/website/ts/pages/documentation/documentation.tsx @@ -111,7 +111,7 @@ export class Documentation extends this.props.docsInfo.getMenuSubsectionsBySection(this.state.docAgnosticFormat); return (
- +

- {this.props.docsInfo.packageName} + {this.props.docsInfo.displayName}

{this.renderDocumentation()} diff --git a/packages/website/ts/types.ts b/packages/website/ts/types.ts index 96eae938d..d2c690ce1 100644 --- a/packages/website/ts/types.ts +++ b/packages/website/ts/types.ts @@ -674,7 +674,7 @@ export interface SectionsMap { } export interface DocsInfoConfig { - packageName: string; + displayName: string; packageUrl: string; websitePath: string; docsJsonRoot: string; -- cgit v1.2.3 From 41938933493af7038c2892cfb9aa049dede1c1cf Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 29 Nov 2017 08:59:57 -0600 Subject: Rename @0xproject/connect to 0x Connect --- packages/website/md/docs/connect/installation.md | 2 +- packages/website/md/docs/connect/introduction.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/website/md/docs/connect/installation.md b/packages/website/md/docs/connect/installation.md index 2d3755352..2f0acbf10 100644 --- a/packages/website/md/docs/connect/installation.md +++ b/packages/website/md/docs/connect/installation.md @@ -12,4 +12,4 @@ import {HttpRelayerClient} from '@0xproject/connect'; ### Wiki -Check out our [@0xproject/connect introduction tutorial](https://0xproject.com/wiki#Intro-Tutorial:Connect) for articles on how to get 0x.js setup with TestRPC, Infura and more! +Check out our [0x connect introduction tutorial](https://0xproject.com/wiki#Intro-Tutorial:Connect) for articles on how to get 0x.js setup with TestRPC, Infura and more! diff --git a/packages/website/md/docs/connect/introduction.md b/packages/website/md/docs/connect/introduction.md index 9b49cafff..ee08a46e2 100644 --- a/packages/website/md/docs/connect/introduction.md +++ b/packages/website/md/docs/connect/introduction.md @@ -1 +1 @@ -Welcome to the [@0xproject/connect](https://github.com/0xProject/0x.js/tree/development/packages/connect) documentation! @0xproject/connect is a Javascript library that makes it easy to interact with Relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api). Functionality includes getting supported token pairs from a relayer, getting orders filtered by different attributes, getting individual orders specified by order hash, getting orderbooks for specific token pairs, getting fee information, and submitting orders. +Welcome to the [0x connect](https://github.com/0xProject/0x.js/tree/development/packages/connect) documentation! 0x connect is a Javascript library that makes it easy to interact with Relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api). Functionality includes getting supported token pairs from a relayer, getting orders filtered by different attributes, getting individual orders specified by order hash, getting orderbooks for specific token pairs, getting fee information, and submitting orders. -- cgit v1.2.3