Skip to content

06 — Doc impact

Rule: DOC-5 (and STD-4 for the tooling).

standards check-doc-impact [--base REF] compares merge-base(REF, HEAD) with HEAD. For every changed file matching [doc_impact] watched:

  • the file must match at least one [[doc_impact.rules]] entry, otherwise the map is incomplete and the check fails;
  • for each matching rule, at least one of its docs globs must also have changed.
[[doc_impact.rules]]
paths = [".github/workflows/**"]
docs = ["docs/standards/09-ci-cd.md"]

When a change truly needs no documentation, a commit footer says why, and the reason stays in history:

Docs-Reviewed: only generated bytecode is removed; no behaviour changes

The base is --base, else STANDARDS_BASE_REF (CI sets it to the PR base or the previous main), else origin/main. With no base (a first push), the check is skipped with a note. Globs: * stays within a path segment, and ** crosses segments.