Skip to main content

To do today

  • Create All components
  • Move pages layout
  • Fix all pages (components)
    • Home
    • About
    • Community
    • Developers
    • Gateways
    • Orchestrators
    • Delegators
    • Resources
    • Help & Support
  • Add overview for every page

Pages Checklist

  • Home
    • home.mdx
  • About
    • about.mdx
  • Community
    • community.mdx
  • Developers
    • developers.mdx
    • getting-started.mdx
    • quickstart.mdx
    • development.mdx
  • Gateways
    • gateways.mdx
    • overview.mdx
    • setup.mdx
  • Orchestrators
    • orchestrators.mdx
    • overview.mdx
    • setup.mdx
  • Delegators
    • delegators.mdx
    • overview.mdx
    • staking.mdx
  • Resources
    • resources.mdx
    • faq.mdx
    • glossary.mdx
  • Help & Support
    • help-support.mdx
    • contact.mdx
  • API Reference
    • overview.mdx
    • endpoints.mdx
    • authentication.mdx

To do

Week 1 (1-6 Dec)
  1. Move pages layout
  2. Create All components
  3. Fix all pages (components)
  • Home
  • About
  • Community
  • Developers
  • Gateways
  • Orchestrators
  • Delegators
  • Resources
  • Help & Support
  1. Add overview for every page
  2. Move good content over from old site
  3. Add Headers (buttons?)
  4. Add Footer
  5. Protocol Section
  6. Gateways
  7. Orchestrators
  8. Delegators
Week 2 (7-13 Dec)
  1. Finish Technical Sections
  2. Talk to stakeholders
  3. Put out call for projects (automation form)
  4. HUBs Hook Up
  5. Non-technical sections
Week 3 (14-20 Dec)
  1. DEMO READY (slides, report, forum post)
  2. 17 DEMO & PUBLISH LINK for community
Week 4 ()

Language

     "languages": [
   {
     "language": "en",
     "groups": [
       {
         "group": "Getting started",
         "pages": ["en/overview", "en/quickstart", "en/development"]
       }
     ]
   },
   {
     "language": "es",
     "groups": [
       {
         "group": "Getting started",
         "pages": ["es/overview", "es/quickstart", "es/development"]
       }
     ]
   }
   ```


Build docs.json
-> Using a build script to generate `docs.json` from TypeScript/JavaScript files in the documentation: general approach:

**Create a TypeScript config file** (e.g., `docs.config.ts`):
```typescript
const PATHS = {
api: '/api-reference',
guides: '/guides'
};

export const docsConfig = {
name: "My Docs",
navigation: {
 tabs: [{
   tab: "API",
   pages: [`${PATHS.api}/overview`]
 }]
}
};
Add a build script to package.json:
{
  "scripts": {
    "build:docs": "node scripts/generate-docs.js"
  }
}
Create the generator (scripts/generate-docs.js):
const fs = require('fs')
const { docsConfig } = require('../docs.config.ts')

fs.writeFileSync('docs.json', JSON.stringify(docsConfig, null, 2))
Run before deployment to generate your docs.json dynamically.