AppendixContributing
Working on the Docs Site
The docs app structure, Bun commands, and how to add or reorganize documentation pages.
The documentation site lives at:
apps/docs/It is a self-contained Bun app built with:
- Next.js App Router
- Fumadocs
- Fumadocs MDX source generation
- static search indexes
Important Folders
apps/docs/
app/
components/
lib/
llms/
api/
content/docs/
public/Use:
app/for the homepage, docs route shell, API routes, and LLM helper routescontent/docs/for the actual English documentation pagesmeta.jsonfiles to control page order and grouping in the sidebar
Local Workflow
cd apps/docs
bun install
bun run devType-check and source generation:
bun run typecheckStatic build:
bun run buildAdding A New Page
- Add an
.mdxfile under the correct folder incontent/docs/. - Update the folder's
meta.jsonif you want explicit ordering. - Link to the page from nearby overview pages when it affects navigation.
- Run
bun run typecheckandbun run build.
Versioning Readiness
The site currently publishes only latest English docs.
It is still organized so future versioning is possible:
- stable section slugs
- a clear content tree
- homepage separate from
/docs
When versioning is introduced later, keep the current slugs stable unless the underlying product meaning has changed.