Expand description
Where an instance keeps the documents the gates read.
One of these locations is declared rather than fixed: the docs scratch. It is recorded in the manifest and named by one environment variable, and the variable wins where it is set.
The documentation root comes from the manifest when one exists, is
discovered from the conventional layouts when none does, and defaults to
_docs. Known-issue roots follow the same ladder, and explicit arguments
win over all of it — a repository keeping records outside the root passes
the directories holding them. Nothing here judges content; that is each
gate’s business.
Functions§
- docs_
root - The instance’s documentation root, relative to the repository.
- docs_
scratch - Resolve the docs scratch: the variable first, then the recorded path.
- docs_
scratch_ variable - What
DOCS_SCRATCH_VARcarries here, orNonewhen it is unset. - docs_
scratch_ with - The resolution, with the variable’s value supplied.
- ki_
record_ roots - The directories that may hold known-issue records, relative to the repository. Arguments win; a manifest names one root; a bare consumer’s roots are discovered.
- ki_
records - Every known-issue record the instance carries, unfiltered.
- ki_
records_ judged - Every known-issue record under the resolved roots, repository-relative.