Skip to content
Version: Current

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…

  • 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.

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.