Doc-Sentinel AI hooks into your CI/CD pipeline and flags drift between your code and your documentation on every pull request — before anything ships.
The code diff introduces changes to the start_ai_audit function signature — adding optional mode and version parameters — that are not reflected in the existing documentation.
start_ai_audit(api_key, mode='strict', version=2)
The documentation score of 70% indicates room for improvement in agent-friendliness. Recommend defining parameters with explicit type annotations and adding an examples section for AI retrieval accuracy.
Doc-Sentinel runs silently in the background on every pull request, so documentation debt never compounds unnoticed.
A developer pushes code or opens a PR. Doc-Sentinel wakes up automatically via GitHub Actions — no manual trigger needed.
Doc-Sentinel fetches the latest git diff and the corresponding documentation from your repository via the GitHub API.
The Drift Audit checks whether code changes are reflected in the docs. The Intelligence Audit scores the documentation for AI-readability against the Style Guide.
A bot comment appears on the pull request with a severity label, a plain-English explanation of what drifted, and a corrected Markdown snippet ready to paste in.
Doc-Sentinel pairs with Doc Detective to give you both drift detection and functional validation — the full picture.
Built in collaboration with @hawkeyexl from Doc Detective.
Add Doc-Sentinel to your GitHub Actions pipeline in under five minutes. Free and open source, forever.
★ Star on GitHub