Skip to main content

Module paths

Module paths 

Source
Expand description

Where an instance keeps the documents the gates read.

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.
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 under the resolved roots, repository-relative.