The sync-docs skill automates the critical task of keeping documentation in lockstep with codebase evolutions. By analyzing git history and mapping code symbols to Markdown files, it identifies version mismatches, broken code examples, removed exports, and missing changelog entries. It provides a structured audit of documentation health and suggests precise fixes, ensuring that READMEs, CHANGELOGs, and internal guides always accurately reflect the current state of the source code, reducing the maintenance burden on developers.
主な機能
01Identification of version mismatches between package manifests and docs
02Automated detection of stale documentation based on git change history
03Integration with repo-maps to find and report undocumented exports
04692 GitHub stars
05Detection of broken code examples and removed symbol references
06Automated CHANGELOG auditing and update suggestions
ユースケース
01Identifying functions or classes that have been added to code but are missing from documentation
02Updating CHANGELOG.md automatically based on recent commit messages
03Auditing documentation before a Pull Request or release to ensure accuracy