Docs Quality Checks

Use these checks before opening documentation-heavy PRs.

Quick run 

make docs-check

This runs:

  • make docs-path-check for backtick path references.
  • make docs-link-check for markdown link validity.
  • make docs-index-check for section index coverage.
  • make docs-nav-quality-check for front matter, valid parent chains, and folder-backed nav enforcement.
  • make docs-lifecycle-check to block roadmap/phase/backlog tracker artifacts in docs/.
  • make docs-web-route-check for web route documentation consistency.
  • make docs-architecture-budget-check to enforce concise architecture pages (<=150 lines for non-index pages).

For onboarding docs, run quick consistency greps:

rg -n "docker compose|make bootstrap" README.md docs/running
rg -n "FRACTURING_SPACE_AI_ORCHESTRATION" docs/running .env.example .env.local.example
rg -n "defined by an email|independent of any email address" docs/architecture/foundations/domain-language.md docs/architecture/platform/identity-and-oauth.md
rg -n "WEBAUTHN_RP_ORIGINS|MAGIC_LINK_BASE_URL" docs/running/configuration.md docs/architecture/platform/identity-and-oauth.md internal/services/auth