Documentation
¶
Overview ¶
Package docscheck keeps the planning documents honest.
docs/plans/oss-feature-completeness-matrix.md is a source-backed inventory: every row names the code that is supposed to implement the workflow. Those paths rot silently whenever a package moves, and a stale row then reads as evidence for a feature nobody can find. CheckMatrix resolves every reference and reports the ones that no longer exist, so the matrix cannot drift away from the repository without failing a test.
CheckRecordedSeams additionally requires DESIGN.md to cite the five architecture seam packages. A rename of locator, transition, idle, PlanFor or worldstore fails this package's tests.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var RecordedSeams = []RecordedSeam{
{Name: "Locator", Path: "internal/docker/locator.go"},
{Name: "lifecycle handle", Path: "internal/docker/transition.go"},
{Name: "idle-power module", Path: "internal/docker/idle.go"},
{Name: "route PlanFor", Path: "internal/proxy/plan.go"},
{Name: "worldstore", Path: "internal/worldstore"},
}
RecordedSeams are the five landed runtime, lifecycle and world-data seams.
Functions ¶
This section is empty.
Types ¶
type Problem ¶
Problem is one matrix defect with the row it came from.
func CheckMatrix ¶
CheckMatrix reads the matrix and verifies that every path it cites exists under root, that feature IDs are unique, and that every row carries a status word the legend defines.
func CheckMatrixText ¶
CheckMatrixText is CheckMatrix for an in-memory document.
func CheckRecordedSeams ¶
CheckRecordedSeams verifies that DESIGN.md cites each architecture seam package and that those paths still exist under root.
type RecordedSeam ¶
RecordedSeam is one architecture package DESIGN.md must name.