LLM engineering · Python

Self-Healing Docs

Docs go stale one commit at a time: a function is removed or a parameter renamed, and the page that shows it is not touched. This checker reads the public API from the code, finds every doc section that uses what just changed, and fails the pull request, suggesting the edit for renames. Below: every breaking change in httpx's history that its docs were using, and what happened to those docs.

How long each doc section stayed wrong

Every breaking change the docs used

Commit links go to httpx on GitHub. A change the maintainers documented in the same commit leaves nothing stale; the checker's job is the rest.