Skip to main content
Detail’s Doc Fixes agent detects when code changes make documentation stale and automatically opens GitHub pull requests to update it. Documentation drift — where the code moves forward but the docs still describe the old behavior — is one of the most common and most invisible forms of technical debt. Detail finds it and fixes it for you.

​
What documentation drift looks like

Documentation drift happens gradually:
  • A function’s signature changes but its docstring still describes the old parameters
  • A module is refactored and its README still shows the old API
  • A configuration option is renamed but the docs still use the original name
  • New behavior is added to a function without a corresponding update to its documentation
Each of these cases causes confusion for developers reading the docs and erodes trust in your documentation over time.

​
How it works

1

Agent reviews recent code changes

The Doc Fixes agent compares recent commits against your repository’s documentation — inline docstrings, README files, and dedicated docs directories — and identifies places where the documentation no longer accurately describes the code.
2

A pull request is opened

For each documentation drift issue found, the agent opens a GitHub pull request with the updated documentation. The PR description explains what changed in the code and why the docs needed to be updated.
3

You review and merge

Review the PR diff, make any additional edits you want, and merge when you’re satisfied. The updated docs land in your repository just like any other PR.

​
Enabling Doc Fixes

1

Open repository settings

In the Detail dashboard, go to Settings → Repositories and select the repository you want to configure.
2

Enable Doc Fixes

Toggle Doc Fixes to on for the repository.
3

Choose a scan frequency

Select how often the agent should look for documentation drift:
  • Weekly — runs once per week, good for repositories with moderate churn
  • Weekdays — runs every weekday, better for repositories with frequent commits

​
What to expect

Diff-focused PRs

Each PR shows exactly which documentation was changed and why — the old text alongside the new, so you can verify the update is accurate before merging.

Standard GitHub workflow

Doc fix PRs behave like any other PR. Comment, request changes, edit the branch directly, or close without merging — you stay in control.

Configurable frequency

Weekly scans work for most teams. Switch to weekdays if your codebase changes rapidly and you want drift caught sooner.

Broad coverage

The agent checks inline docstrings, README files, API documentation, and other doc files it can find in the repository.
Enable Doc Fixes alongside the Bug Finder for comprehensive code health coverage. The Bug Finder keeps your logic correct; Doc Fixes keeps your documentation honest.