Skip to main content

Module guidance

Module guidance 

Source
Expand description

What a release asks of an instance that takes it.

A changelog is written for a reader deciding whether to upgrade. A plan is read by somebody who already decided. The two answer different questions, so the bundle owes the second one as data a plan can filter rather than prose an operator reads whole.

One file per release that needs one, never per release. The index is the complete coverage ledger from the capability floor onward, so a missing prose file cannot strand an interval and a missing entry is a release-time failure rather than a silent gap.

Structs§

Briefing
The preconditions and decisions one interval’s guidance carries.
Guidance
What one release asks, whole.
Index
The complete coverage ledger.
IndexEntry
One release’s coverage.
Step
One thing a release asks.

Enums§

Actor
Who takes one step.
Coverage
How much of an interval the ledger covers.
GuidanceError
Guidance this engine cannot read.
StepKind
What one release asks, in kind.

Constants§

DESTINATIONS
The destination vocabulary a step filters against.
INDEX_PATH
Where the ledger sits inside a bundle.
INDEX_SCHEMA
The ledger schema this engine reads.
NONE
The word an index entry uses when a release asks nothing.
SCHEMA
The step-file schema this engine reads.

Functions§

brief
Read one interval’s guidance against one target.
coverage
What the ledger says about one interval.