phase 1 5 docs site
Docs CI gates: docs-build on PRs, docs-deploy on main. Partial — lychee link check and Lighthouse a11y deferred.
Milestone D.4.2 — GitHub Actions docs checks
Status: Partial
Goal: D.4
Phase: 1.5 — Docs Site
Wave: 11
Estimated effort: 0.5 day
ADR required: None
Spec detail: MASTER_BRIEF.md Part D (D.4.2).
Shipped (2026-06-22)
| Deliverable | Location | Notes |
|---|---|---|
docs-build CI job | .github/workflows/ci.yml | typecheck, Vitest, build:clean |
Path filter (detect-changes) | same | Skips docs-build on Go-only PRs |
| pnpm + Next.js cache | .github/actions/setup-pnpm-docs | Shared composite action |
| Production deploy | .github/workflows/docs-deploy.yml | OpenNext build + Cloudflare deploy + smoke test |
Deferred
| Deliverable | Notes |
|---|---|
.github/workflows/docs-checks.yml | Separate workflow not added; logic lives in ci.yml + docs-deploy.yml |
| lychee on built HTML | Follow-up PR |
| Lighthouse CI (a11y = 100) | Follow-up PR; target production or workflow_dispatch URL |
Why This Milestone Exists
Without CI gates, broken internal links and accessibility regressions reach preview and production silently. Go CI already blocks bad merges — docs need equivalent checks.
Acceptance Criteria
- Docs typecheck, test, and build run on docs path changes
- Go-only PRs skip
docs-buildvia path filter - Production deploy gated by
docs-deployworkflow - PR with intentionally broken link is blocked by lychee (deferred)
- PR with a11y regression is blocked by Lighthouse (deferred)
Edit on GitHub
Last updated on