Version: Current
Historical release snapshot. These docs are frozen. Read current docs.
Docs health
This page reads docs-health.json, which the documentation engine writes on
every detect run. Every number below comes from the same report that decides
what the next cycle writes, so the panel cannot disagree with the work.
Loading docs-health.json…
| Signal | Meaning |
|---|---|
| Coverage | Share of the declared surface (routes, RPCs, commands, flags, error codes) that at least one page mentions. |
| Freshness | Pages older than the newest change in the repository that owns what they describe. |
| Broken examples | Blocks tagged exec that no longer exit zero. |
| Top gaps | The ranked queue, by exposure weight and then observed traffic. |
What each number means
Section titled “What each number means”- Coverage counts a surface item as covered when a published page mentions its path, command or code. It is a floor, not a proof: a mention on a page that does not explain the item is still a gap the detector reports as “mentioned, no section”.
- Freshness compares a page’s last commit with the newest change in the
repository that owns its subject. A page under
acumen/is stale when the gateway changed after it; a generated reference page is stale only from the repository named in its own filename. - Examples counts only blocks tagged
exec. Everything else is quoted for a reader and is never run. - Top gaps is the queue the next cycle draws from. Risk is exposure weight: a public route outranks an internal flag, and observed traffic breaks ties when a signal source provides it.
The snapshot in the repository
Section titled “The snapshot in the repository”public/docs-health.json is committed with each cycle, so a reader without a
browser script still has a dated snapshot, and the git history of that file is
itself the trend line.