Gate: docs-covered

Every spec reaches some documentation page.

Property	Value
Checker	docs-covered
Confronts	spec
Blocking by default — new project	yes
Blocking by default — existing project	no — informs

How it measures

The docs-covered gate asks whether a spec reaches ANY page of the documentation the project compiles from its templates. Its sibling, docs-fresh, asks whether each page that exists still reflects the spec it came from; it cannot see a spec that no page asks for.

That is the silent defect this gate exists for. The templates select specs by filter (by layer, for instance), so a spec that no filter selects compiles to nowhere, and nothing complains: every page that exists is correct, and the unit has a complete unit and passes every relational gate. The first spec of a new layer drops out of the documentation without a word, exactly when the project grows and nobody is watching.

The gate is informative: the fix is a person’s decision, to widen a template’s filter or to add the layer’s page. Rebuilding the documentation does not fix it, because the build only produces the pages the templates ask for.

The answer is a property of the whole set of specs, so it is computed once per project root and map and reused for every spec of the scan. The verdict of each spec, however, is about that spec only.

Declaring it

gates:
  - name: docs-covered
    on: [spec]
    check: docs-covered

Source: checker · its spec