Flow

Adding a project

Register a new service in projects.json and scaffold its documentation silo.

1. Register the project

Add an entry to frontend/docs-app/projects.json:

  • domain — must match a declared domain id
  • slug — stable identifier used by <ProjectHeader slug="…" />
  • docsPath — content path under content/docs/ (must live under the domain's docsPath)
  • sourceDirectories — repository-root paths the silo documents

Validation runs at import time — a malformed registry fails pnpm build.

2. Create content

Add a folder at frontend/docs-app/content/docs/<docsPath>/ with:

  • meta.json — sidebar page order
  • index.mdx — landing page with <ProjectHeader />
  • Topic pages: getting-started, architecture, api, operations (adapt to the service)

Update the parent folder's meta.json to include the new directory name.

3. Extend navigation

If the project starts a new domain, add a domain entry to projects.json and a root section meta.json entry if needed.

4. Verify

pnpm --dir frontend/docs-app check
pnpm --dir frontend/docs-app build

Reconcile docs in the same change as code when behavior, routes, or deployment change.

On this page