docsgen

Overview ¶

Package docsgen writes the generated regions of the documentation from the files that are the source of truth: the JSON schemas, the audit catalogue, the chart's golden alert render and the ADRs.

A region is the text between `<!-- generated: name -->` and `<!-- /generated -->` in a Markdown page. Only the inside of a region is ever rewritten, and the output is a pure function of the sources, so the same tree always yields the same bytes. A marker no generator knows is an error, so a region cannot silently go unchecked.

Not generated, on purpose: the sluisctl command reference (the CLI is stdlib `flag` per command with hand-written usage, so there is no command tree to read) and the telemetry metric catalogue (instruments are created inline across the packages, and their labels exist only at the call sites).