Correct documentation that references code which no longer exists
Documentation pointing at functions, flags, and files that were deleted, corrected and checked automatically.
The ticket
Fix documentation that references code that no longer exists.
Acceptance criteria
- Every code reference in the documentation resolves to real code
- A check verifies references and runs in the pipeline
- Documentation for genuinely removed features is deleted rather than corrected
- The check reports which file and line failed
What lands as proof
An automated reference check, since manual verification decays the week after it is done.
Why teams defer it
- Deleting code does not fail the documentation build, so the reference just rots.
- Distinguishing a renamed symbol from a removed feature needs somebody who knows the history.
Questions
- What does the agent actually change?
- The ticket is scoped to one outcome: fix documentation that references code that no longer exists. Work that serves that outcome is in scope, and anything outside it is left for a separate ticket, so the pull request stays reviewable.
- How do I know the work is done?
- The pull request carries the evidence, not only the diff. Here that means every reference resolves to real code, checked automatically, so a reviewer can confirm the result without reproducing the work locally.
- How much oversight does this need?
- None is required before the run starts. Every claim this ticket makes can be checked by machine, so the agent works straight through and a person reviews the finished pull request like any other.