docs

Overview ¶

Package docs validates the documentation content contract for docs/.

The docs/ directory is plain CommonMark + GitHub-flavored Markdown with no rendering toolchain in this repository; a separate repository consumes it and builds the documentation site. This package enforces the contract that consumer relies on:

• every page parses as Markdown and starts with exactly one level-1 heading (the page title)
• every relative link and image resolves to a file inside docs/, and anchor fragments resolve to a heading in the target page
• every page appears exactly once in toc.yaml, either in a section or in the unlisted set, and every toc.yaml entry names a real page
• no raw HTML or JSX except HTML comments
• no MyST/Sphinx directives left over from the old toolchain