Aller au contenu

Reference

Ce contenu n’est pas encore disponible dans votre langue.

Everything on these pages is generated at build time from the source of truth in the repo. If something looks wrong, the fix is in the code or the spec, not here.

PageGenerated from
API referenceapp/api/openapi.yamloapi-codegen types + starlight-openapi rendering
Database schemaapp/schema.sql — parsed by generate-schema-docs.mjs
Install config table on Install guidedocs/install/config/aa.env.example — parsed by sync-install-config.mjs
Roadmapdocs/roadmap.md — synced by sync-roadmap.mjs
Architecture Decisions (sidebar)docs/adr/*.md — copied by sync-adrs.mjs

Reference pages regenerate on every site build. To preview locally, from the repo root:

Terminal window
pnpm install
pnpm dev

pnpm dev runs the same sync scripts first (via predev), so a local preview always has fresh reference pages.

The prebuild and predev steps in package.json run these in order:

  1. scripts/sync-adrs.mjs — copies docs/adr/*.md into the docs collection with frontmatter inferred from each file’s h1.
  2. scripts/sync-openapi.mjs — copies app/api/openapi.yaml to public/openapi.yaml so the starlight-openapi plugin can read it.
  3. scripts/generate-schema-docs.mjs — parses app/schema.sql and emits the developers/database/ pages: one landing page plus one page per table.
  4. scripts/sync-install-config.mjs — parses docs/install/config/aa.env.example into a Starlight partial that the install guide imports.
  5. scripts/sync-roadmap.mjs — copies docs/roadmap.md into the site as a top-level page.
  6. scripts/sync-screenshots.mjs — copies product screenshots from docs/screenshots/*.png into src/assets/ so Astro can optimize them.

Adding a new auto-sync is one more node scripts/whatever.mjs && in the chain.