diff options
Diffstat (limited to 'packages/website/ts/types.ts')
-rw-r--r-- | packages/website/ts/types.ts | 52 |
1 files changed, 24 insertions, 28 deletions
diff --git a/packages/website/ts/types.ts b/packages/website/ts/types.ts index 403af9e78..c20b09cd5 100644 --- a/packages/website/ts/types.ts +++ b/packages/website/ts/types.ts @@ -468,33 +468,6 @@ export interface CustomTypeChild { defaultValue?: string; } -export const ZeroExJsDocSections = strEnum([ - 'introduction', - 'installation', - 'testrpc', - 'async', - 'errors', - 'versioning', - 'zeroEx', - 'exchange', - 'token', - 'tokenRegistry', - 'etherToken', - 'proxy', - 'types', -]); -export type ZeroExJsDocSections = keyof typeof ZeroExJsDocSections; - -export const SmartContractsDocSections = strEnum([ - 'Introduction', - 'Exchange', - 'TokenTransferProxy', - 'TokenRegistry', - 'ZRXToken', - 'EtherToken', -]); -export type SmartContractsDocSections = keyof typeof SmartContractsDocSections; - export interface FAQQuestion { prompt: string; answer: React.ReactNode; @@ -689,4 +662,27 @@ export enum WebsitePaths { About = '/about', Whitepaper = '/pdfs/0x_white_paper.pdf', SmartContracts = '/docs/contracts', -} // tslint:disable:max-file-line-count +} + +export interface DocsMenu { + [sectionName: string]: string[]; +} + +export interface SectionsMap { + [sectionName: string]: string; +} + +export interface DocsInfoConfig { + packageName: string; + packageUrl: string; + websitePath: string; + docsJsonRoot: string; + menu: DocsMenu; + sections: SectionsMap; + sectionNameToMarkdown: {[sectionName: string]: string}; + publicTypes?: string[]; + sectionNameToModulePath?: {[sectionName: string]: string[]}; + menuSubsectionToVersionWhenIntroduced?: {[sectionName: string]: string}; +} + +// tslint:disable:max-file-line-count |