Module paths 

Where an instance keeps the documents the gates read.

Two of these locations are declared rather than fixed: the plan zone and the docs scratch. Each 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.

Enums

PlanZoneTarget

Where a gate may look for entry documents, and what named the place.

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_VAR carries here, or None when 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.

plan_zone

Resolve the plan zone: the variable first, then the recorded kind.

plan_zone_with

The resolution, with the variable’s value supplied.