/projects

Docs Debt Radar

a documentation drift scanner that checks doc claims against the actual repo

  • TypeScript
  • Node.js

github.com/Conalh/docs-debt-radar ↗

Docs Debt Radar is a truth layer for fast-moving repos. It extracts checkable claims from your Markdown — package scripts, routes, env vars, links, screenshots, workflow steps — and compares them against the current repository, emitting conservative, evidence-backed findings with the exact doc line, the current fact, the rule, and a suggested edit.

It ships as a CLI, a GitHub Action, and an optional static report viewer, with output as text, markdown, JSON, SARIF, patch, or an agent-handoff mode — so CI catches documentation rot before it misleads anyone.