Getting started
Run the docs site locally and make your first change.
Run it
pnpm install
pnpm devThe site is served at localhost:3000/docs.
The two content sources
| Source | Lives in | Rendered by |
|---|---|---|
| Guides | content/docs/**/*.mdx | Fumadocs MDX |
| API reference | content/api-specs/{env}.openapi.json | Generated pages under /docs/api-reference |
Sidebar navigation for both is precomputed into content/api-specs/*.nav.json
by scripts/generate-sidebar.py and loaded server-side — the client nav never
walks the content tree itself.
API environment
The API is configured in lib/api-environments.ts and served from
https://vsqrd.com; the reference lives at /docs/api-reference. Run
pnpm sync:api to pull the live spec and regenerate the reference.
Useful scripts
| Command | What it does |
|---|---|
pnpm sync:api | Pull OpenAPI for all envs, rebuild manifests, nav and status |
pnpm sidebar:gen | Regenerate nav JSON from local content + manifests |
pnpm check:links | Verify internal links resolve |
pnpm types:check | MDX typegen + tsc --noEmit |