DOCUMENTATION / GitHub community (awesome-copilot)
Documentation Drift Audit
Compare documentation claims with repository code and configuration using a bounded evidence report.
“Run a read-only documentation drift audit for a feature, PR, branch, release, API, configuration change, workflow, CLI, package, or repository area. Use when the user asks whether docs are stale, missing, inconsistent with code, or need updates after code changes. Checks README files, setup guides, API docs, env docs, changelogs, examples, comments, generated docs, and user-facing instructions. This is not a general code review; it compares what the docs claim against what the code does.”
01 / THE REASONING
Why this made the selection.
- docs_drift.py checks command names, filesystem links and regex-derived env references; the definition requires manual confirmation and separates inferred gaps from confirmed drift.
- Find setup commands, relative links and environment documentation that have drifted after a feature change.
02 / THE REVIEW RECORD
What we actually inspected.
Source review has boundaries.
A clear record is more useful than a “safe” badge.
Material inspected
- skills/docs-sync-audit/SKILL.md
- skills/docs-sync-audit/scripts/docs_drift.py
- LICENSE
- README.md
Our findings
- docs_drift.py checks command names, filesystem links and regex-derived env references; the definition requires manual confirmation and separates inferred gaps from confirmed drift.
- Full-repository reviews inventory documentation surfaces before deeper inspection and explicitly list untouched surfaces; generated documentation not regenerated remains an identified residual risk.
Not established by this review
- Third-party instructions and helpers were not executed; service access, host compatibility and outcomes remain untested.
- Not executed: it was not installed or run.
The review applies to the material and revision named here. A newer upstream release can change its behavior.
03 / PUT IT TO WORK
Add a skill to your workflow.
DOCUMENTED COMMAND
npx skills add github/awesome-copilot/skills/docs-sync-auditRun in your terminal to choose your AI tools, project or global scope, and installation method. This short command follows the current upstream version; the review covers the revision shown above.
Optional: install the reviewed revision
Keeps the original source and installer version where recorded, while leaving your AI tools and installation scope for you to choose.
npx skills add https://github.com/github/awesome-copilot/tree/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/skills/docs-sync-audit- Install the pinned directory interactively and retain its referenced files; inspect the source before granting tool access.
- Inventory the requested scope, inspect the Python helper before use and confirm every reported mismatch in both docs and implementation; list surfaces not deeply inspected.
Before you start
- Python standard library, repository read access and optional Git for tracked-file/history discovery
04 / FOLLOW THE EVIDENCE
The source trail.
Our notes are separate from the original resource.
Check upstream before adopting a new version.
https://github.com/github/awesome-copilot/blob/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/skills/docs-sync-audit/SKILL.md
Supports: summary, review, install, access, limitations
https://github.com/github/awesome-copilot/blob/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/skills/docs-sync-audit/scripts/docs_drift.py
Supports: summary, review, install, access, limitations
- Pinned LICENSE ↗Checked
https://github.com/github/awesome-copilot/blob/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/LICENSE
Supports: license
- Pinned README.md ↗Checked
https://github.com/github/awesome-copilot/blob/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/README.md
Supports: summary, review, install, access, limitations
https://raw.githubusercontent.com/github/awesome-copilot/f25421d3f1b8b3bb217f78a7c0567cf7ec117cd8/skills/docs-sync-audit/SKILL.md
Supports: review.findings, bestFor