Make documentation changes part of public API changes
Public exports, schema keys, compiler output, typegen, CLI commands, test helpers, and support stances should fail CI when the docs do not change with them.
This is the maintainer checklist for keeping the docs from becoming a prose archive again. The tests cover drift; the manual QA checklist covers developer paths a test cannot fully feel.
- Best for
- Release and review checklists
- Main command
- Generated file
- must match the docs model
Docs must change when these public surfaces change
| Changed surface | Docs or test that must move |
|---|---|
| Public exports | Package entrypoint table and export drift test. |
| Config schema keys or binding compiler output | Binding guide manifest and schema coverage test. |
| Typegen output | Generated types docs and first binding examples. |
| CLI commands or help pages | CLI docs and command table drift test. |
| helpers | and helper coverage checks. |
| Cloudflare support stance | , binding pages, and support matrix snapshot. |
| Docs content model | Regenerate and pass generated handbook drift check. |
Final manual QA checklist
- New user path: -> -> works as a narrative.
- Binding path: -> one binding page -> matching testing guide.
- Test path: names the smallest helper and cleanup pattern.
- Deploy path: distinguishes build, dry-run, prod, preview, and cleanup.
- Remote-boundary path: and binding pages make auth, Docker/Podman, paid services, and skips explicit.
Wire the docs gate into a CI job
name: docs
on:
pull_request:
jobs:
verify-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
- run: bun install --frozen-lockfile
- run: bun run --cwd apps/documentation check
- run: bun run devflare:docs-integrity
Previous
Testing & automation
Local harness detail stays on the testing pages. This page covers what gets promoted into CI and how automation stays observable.
Next
Feature index
This page is the compact feature support index that keeps support level, Cloudflare boundary, test helper, preview lifecycle, and docs links in one place.