Skip to main content

Documentation Guidelines

Where documentation lives​

website/
├── docs/
│   ├── intro.md             # Landing page
│   ├── faq.md               # FAQ
│   ├── user-guide/          # Hand-authored user guides
│   ├── contributing/        # Hand-authored contributor guide (this section)
│   └── api/                 # Auto-generated API reference (TypeDoc)
├── src/                     # Docusaurus React components
├── static/                  # Images, assets
└── docusaurus.config.ts     # Site configuration

The api/ directory is regenerated by TypeDoc on every build from TSDoc comments in src/. Don't edit those files by hand. Everything else under docs/ is hand-authored.