phase 1 5 docs site

IA skeleton alone does not exercise Callout, Steps, and code blocks on real topics. Each content section must meet a minimum bar (H1, lede, one component, one runnable snippet) before the next section starts. Split into section PRs (Getting Started, Proxy+Auth, Deployment+Ops) per wave plan — no mega-PR for all stubs.

Milestone D.3.2 — Seed pages (content by section)

Status: Complete (waves 1–3+ merged in #117, #121, #123)
Goal: D.3
Phase: 1.5 — Docs Site
Wave: 6–8
Estimated effort: 1–2 days per section PR
ADR required: None

Spec detail: MASTER_BRIEF.md Part D (D.3.2).


Why This Milestone Exists

IA skeleton alone does not exercise Callout, Steps, and code blocks on real topics. Each content section must meet a minimum bar (H1, lede, one component, one runnable snippet) before the next section starts.

Split into section PRs (Getting Started, Proxy+Auth, Deployment+Ops) per wave plan — no mega-PR for all stubs.

Forces design system validation across page types before quickstart polish (D.3.3).


Non-Goals

  • Polished 5-minute quickstart (D.3.3)
  • Manual API reference (D.3.4)
  • Phase 2 features documented as shipped

Branch

feat/d3-2-content-sections

PR Title

docs(docs): content section (D.3.2 wave)


Prerequisites


Deliverables

  • Minimum viable page for every leaf in active section PR
  • Each stub: H1, 1-sentence lede, one Callout or Steps, one runnable snippet
  • Phase 1 honesty banner where API is stubbed

See MASTER_BRIEF Part D (D.3.2) for full acceptance detail.


Files Affected

File PathActionNotes
docs/app/content/docs/**/*.mdxModifySection content per wave
docs/app/content/roadmap/phase-1-5-docs-site/CONTENT_SOURCESReferenceSource mapping

Testing Requirements

  • verifyContent_NoEmptyPages: No leaf renders empty placeholder
  • verifyContent_RunnableSnippet: At least one fenced code block per page in section
  • verifyDocsBuild_Section: pnpm docs:build exits 0 after section merge

Acceptance Criteria

  • Every leaf in section renders without empty placeholder
  • Each page has Callout or Steps plus one code snippet
  • pnpm docs:build succeeds

Risks

RiskProbabilityImpactMitigation
Copy-paste examples drift from MakefileHighHighRun make dev-smoke when editing Getting Started
Over-promising Phase 2 APIsMediumHighCross-check CURRENT_STATE implemented surface
Section PR too large for reviewMediumMediumOne sidebar section per PR max
Edit on GitHub

Last updated on

On this page

0%