Gate: docs-fresh
The compiled docs/*.md reflects the spec it came from.
| Property | Value |
|---|---|
| Checker | docs-fresh |
| Confronts | spec |
| Blocking by default — new project | yes |
| Blocking by default — existing project | no — informs |
How it measures
Section titled “How it measures”Confronts the compiled documentation against the specs that feed it: the page is there and it reads well, but is it still saying what the spec says today?
The documentation is GENERATED. The templates reference passages of the specs, and the build command produces the pages. The content lives in the spec and only there — the copy that lives in the compiled output is derived, and derived ages.
Without a gate the failure mode is silent and known: someone changes a rule in the spec, forgets to recompile, and the documentation goes on asserting the OLD rule. Nobody sees it, because the page is there, well formed, with real content. That is worse than an empty page — an obviously incomplete document sends the reader looking for the source; an out-of-date document convinces.
INFORMATIVE by explicit decision: a gate that blocks something a single command fixes on its own spends a reviewer’s attention on machine work. The pipeline runs the build on merge; this gate exists so the author sees it before.
Anchored on the SPEC because the spec is what changes. The compiled document is not a node of the map — it is generated, and charging a review of a compiler’s output would be charging a review of a compiler’s output — so there is nowhere to start but the source.
Declaring it
Section titled “Declaring it”gates: - name: docs-fresh on: [spec] check: docs-fresh