Skip to content

Plan — docs platform slice

This is the checklist that built the documentation site, and it is finished. Seven steps: stand the site up, move the existing documents onto their proper shelves, add the checks that fail the build when something is wrong, generate the current-state page, build the first visual board, publish it behind a login, and add a reminder to the code-review template. Each step carries the test that proves it worked, so “done” is a fact rather than an opinion. It went live on 20 August 2026 on the team’s documentation site, reachable only by people on the invited list. Two small follow-ups are noted at the end; neither blocks anything.

Implements specs/docs-platform.md (approved 2026-08-20). Each step has an acceptance line; the plan is done when all are true.

  1. Scaffold docs-site/ — Astro + Starlight reading ../docs and ../CONTEXT.md; content-collection schema = the frontmatter contract; monochrome zinc tokens, light + dark; Pagefind search; Mermaid at build. Accept: bun run build produces a static site with the ADRs, the target tree, the decision record, the brand docs and the glossary.
  2. Move existing docs into the ladder — frontmatter on the five ADRs (status: accepted), the target tree (design, approved), the decision record (dated), brand docs; docs/vision.md written as the product vision (no business numbers). Accept: every document under docs/ validates against the schema.
  3. Checksbun run docs:lint locally and in CI: frontmatter schema, internal links, ADR numbering, updated freshness on content change. Accept: a doc with a missing status fails the build.
  4. Current-state index — generated landing page: decisions by status, systems (specs) with status/owner/updated and plan progress, in-flight plans, open questions extracted from approved specs, last 20 docs commits, commit-hash footer on every page. Accept: the page reflects a status change with no manual edit.
  5. Board kit + first board — journey lanes, system map, state grid, mock frame, timeline; docs/boards/from-invite-to-home.mdx. Accept: the board’s stages are read from the decision record / specs, not typed into the page.
  6. Deploy + gate — build step in the Deploy Site action, output under /docs/ in the existing Pages project; Cloudflare Access application on qren.ai/docs* with the first allow list (operator dashboard step). Accept: an allow-listed teammate opens qren.ai/docs; anyone else hits the Access login.
  7. PR template with the “spec updated?” check.

Done 2026-08-20. Live at qren.ai/docs behind the Access gate (verified: unauthenticated request → 302 to the PIN login; qren.ai/ stays public). Follow-ups, not blocking: a pull_request workflow running docs:lint + docs:freshness; surfacing docs/context/ as a Contributing section.