Documentation is validated in CI
Why it matters
Documentation that isn't validated in CI can rot silently: links break, code examples go stale, and the docs site fails to build — all without anyone noticing until a user reports it. iso-25010:2011 reliability.maintainability measures exactly this: a project where documentation quality is not continuously verified is a project where documentation quality will degrade over time. For vibe-coded projects that ship quickly and update frequently, undiscovered documentation rot is the rule, not the exception. A single markdown-link-check step in CI catches broken links before they reach users.
Severity rationale
Info because broken documentation validation doesn't affect runtime behavior, but it signals a maintenance posture that allows documentation quality to degrade silently across all future changes.
Remediation
Add a docs validation job to your CI pipeline. A minimal GitHub Actions workflow:
# .github/workflows/docs.yml
name: Docs
on: [push, pull_request]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci
- run: npm run docs:build
- run: npx markdown-link-check README.md docs/**/*.md
At minimum, validate that the docs site builds and that links in README.md resolve. Add npx markdown-link-check for link validation and a docs build step if the project has a generated docs site. Broken CI docs checks should block merge, not just warn.
DetectionPro
The detection method for this pattern is part of AuditBuffet Pro.
The full method (what to look for, pass and fail conditions, and how results get reported) ships inside the Developer Documentation Audit. The pattern definition, severity rationale, and remediation remain openly licensed under CC-BY-4.0.
External references
- iso-25010:2011 · reliability.maintainability — Maintainability via CI validation of documentation assets
Taxons
History
- 2026-04-18·v1.0.0·Initial import from developer-documentation·automated