Content waves (D.3.2+) need a fixed sidebar tree before writers add pages. Ad-hoc folder creation causes nav drift from MASTER_BRIEF §D.3.1 and broken `meta.json` ordering. Search indexing (D.2.5) and Vercel preview review (D.4.1) require every route to resolve — even stubs.
Milestone D.3.1 — Information architecture + meta.json
Status: Complete
Goal: D.3
Phase: 1.5 — Docs Site
Wave: 5
Estimated effort: 0.5 day
ADR required: None
Spec detail: MASTER_BRIEF.md Part D (D.3.1).
Why This Milestone Exists
Content waves (D.3.2+) need a fixed sidebar tree before writers add pages. Ad-hoc folder creation causes nav drift from MASTER_BRIEF §D.3.1 and broken meta.json ordering.
Search indexing (D.2.5) and Vercel preview review (D.4.1) require every route to resolve — even stubs.
Placeholder stubs (H1 + one sentence) prove build and nav without blocking on full content quality.
Non-Goals
- Full content for every page (D.3.2 section PRs)
- OpenAPI-generated API pages (Phase 2)
- Changing sidebar tree without updating MASTER_BRIEF
Branch
feat/d3-1-ia
PR Title
docs(docs): information architecture skeleton (D.3.1)
Prerequisites
Deliverables
- Full sidebar tree per MASTER_BRIEF §D.3.1 (Getting Started, Proxy, Auth, Deployment, API, Changelog)
meta.jsonper folder with orderedpagesarray- Placeholder MDX per leaf: H1, one sentence, "Coming soon" Callout
See MASTER_BRIEF Part D (D.3.1) for full acceptance detail.
Files Affected
| File Path | Action | Notes |
|---|---|---|
docs/app/content/docs/**/meta.json | Add | Folder ordering |
docs/app/content/docs/**/*.mdx | Add | Placeholder stubs per leaf |
Testing Requirements
verifyIA_SidebarMatchesBrief: Sidebar tree equals MASTER_BRIEF §D.3.1verifyIA_EveryLeafBuilds:pnpm docs:buildsucceeds with all stubsverifyIA_FrontmatterPresent: Every leaf hastitleanddescription
Acceptance Criteria
- Sidebar matches authoritative tree exactly
- Every leaf page has frontmatter
titleanddescription -
pnpm docs:buildexits 0
Risks
| Risk | Probability | Impact | Mitigation |
|---|---|---|---|
| Slug typo breaks link checker later | Medium | High | Generate paths from brief tree checklist |
| Stub pages indexed with thin content | Low | Medium | Add robots noindex on stubs until D.3.2 fills content |
| API Reference folder promises OpenAPI | Medium | Medium | Label manual Phase 1 API in stub; D.3.4 clarifies |
Last updated on