README.md

Stellar docs

yarn start to start local development.

src/ contains all documentation, API reference sections, and web assets (images, videos, pdfs) needed for the docs. Each page is authored as an index.mdx document, with translations of those documents as index.localeCode.mdx.

Each folder must have a metadata.json file with 3 keys:

{
  "url": "url-segment",
  "order": 0,
  "title": "Display Name in Nav"
}

folders may be nested, which means that a final URL may be stitched together from multiple metadata files.

src/
├── documentation/
│   ├── metadata.json
│   ├── index.mdx
│   ├── index.es.mdx
│   └── walkthroughs/
│       ├── metadata.json
│       └── index.mdx
└── reference/
    ├── metadata.json
    ├── index.mdx
    ├── index.es.mdx
    └── horizon/
        ├── metadata.json
        └── index.mdx