Synchronizes IdeaVim documentation with code changes by verifying API signatures and implementation patterns.
Doc Sync is a specialized Claude Code skill designed to maintain the integrity of documentation within the IdeaVim project. It bridges the gap between the codebase and its written guides—including READMEs and contribution files—by treating documentation as 'guilty until proven innocent.' The skill employs a code-first truth hierarchy, verifying that every function call, parameter, and usage pattern mentioned in the docs exists in the current implementation. Whether triggered by recent code commits or a proactive documentation audit, it identifies discrepancies, validates API signatures against source files, and ensures code examples remain functional and accurate.
主要功能
01Bi-directional verification between documentation and source code
02Git history integration to identify breaking changes and removed features
03Aggressive discrepancy detection with conservative, style-preserving updates
04Ground-truth analysis using actual Kotlin implementations and API definitions
05Automated extraction and validation of function signatures and parameters
060 GitHub stars
使用场景
01Ensuring new features are correctly reflected in CONTRIBUTING.md guidelines
02Auditing existing README.md and doc/ folders for outdated code examples
03Verifying documentation accuracy after a major refactoring or API change
