DocDrift: Your Code Drifted. Your Docs Didn't Have To.

Описание и применение

DocDrift автоматически обнаруживает и исправляет расхождения между кодом и документацией, генерируя PR‑запросы для обновления README и других файлов.

Задача

When code changes (renamed env vars, default ports, moved endpoints) the README and other docs become outdated, leading to broken references that simple string‑matching tools miss.

Результат

DocDrift automatically detects and patches documentation drift, producing a human‑reviewable PR that updates README tables, env examples, and route references while preventing hallucinated links and preserving markdown structure.

Рабочий процесс

• Intake repository and branch
• Extract code symbols via tree‑sitter AST
• Parse docs (.md, .env.example) into typed targets
• Gemma synthesizes drift findings
• Gate 1 validates findings against extracted symbols
• Patch docs in a shadow copy
• Gate 2 re‑parses patched docs to ensure tables stay well‑formed
• Tone the diff for readability
• Emit unified diff and PR metadata

Доказательства

DocDrift compares values and shapes, not just string existence.

Источник

Gate 1 then drops every claim the AST can't prove — no phantom links survive — and Gate 2 applies the proposed patch to a shadow copy of your docs, re‑parses it, and refuses edits that would break a markdown table.

Источник

The output is a unified diff, a humanized PR title and body, and a full step trace with timings.

Источник