Docgrity: Documentation Integrity Tool for AI Code
Meet Docgrity, a new tool designed to scan Markdown repositories for outdated or contradictory documentation with VS Code and CLI support.
Stock photo for illustration only, not from the actual event
- Docgrity detects stale and contradictory documentation in code repositories.
- Supports VS Code extension, local CLI, and CI via GitHub Actions.
- Verifies findings against actual files before reporting issues.
- Open-source under MIT license with zero telemetry or servers.
As AI-assisted coding becomes a standard workflow, developers frequently face an unexpected side effect: every agent session leaves behind a trail of documentation files such as PLAN.md, TODO.md, and multiple architecture notes that eventually leave repositories cluttered and unreliable.
Outdated or contradictory documentation is no longer just confusing for human developers; it also serves as misleading context for the next AI agent working on the codebase.
Stock photo for illustration only, not from the actual event
To address this challenge, Docgrity was created to scan repository Markdown files for inconsistencies. Key features of the tool include:
- Verifying source text against actual files before reporting any findings.
- An interactive VS Code dashboard featuring clickable evidence and draft GitHub issues.
- A read-only, local-first CLI utilizing Ollama by default.
- CI integration with deduplicated issues that automatically close upon resolution.
Managing repository documentation automatically has become crucial in modern software development. As AI agents continuously generate text files, automated integrity checks ensure that both human teams and AI models rely on accurate, verified project knowledge.
Additionally, a version of Docgrity for Confluence is currently in development as an early-stage Forge app to detect duplicates and contradictions across Confluence spaces, available via direct installation.
Docgrity is built to operate with zero infrastructure, no servers, no telemetry, and is distributed under the MIT license.
Source: Dev.to
Found something wrong in this article? Report an issue with this article
Comments
Leave a Comment