What problem does it solve?
Documentation often falls out of sync with implementation after refactors, feature changes, or API updates, causing confusion, failing examples, and incorrect onboarding material. This Skill helps teams detect those mismatches early by comparing docstrings, README examples, and configuration references against the actual code.
Core Features & Use Cases
- Docstring Analysis: Inspect public functions, classes, and methods to flag parameter, return, and behavioral inconsistencies between docstrings and implementation.
- README/Markdown Validation: Verify code references and usage examples in README and docs/*.md files against the current codebase to detect removed or renamed symbols and outdated examples.
- Config and Schema Checks: Scan pyproject.toml, CI workflows, Makefiles, and other config files for references to removed scripts, entry points, or keys not found in code.
- Use Case: Run after a large refactor or before merging a feature branch to produce a concise report of confirmed documentation mismatches to guide edits and PR notes.
Quick Start
Run the doc-drift skill on a feature branch to scan changed files and produce a consolidated drift report.
