Keeps IdeaVim documentation in sync with code changes. Use this skill when you need to verify documentation accuracy after code changes, or when checking if documentation (in doc/, README.md, CONTRIBUTING.md) matches the current codebase. The skill can work bidirectionally - from docs to code verification, or from code changes to documentation updates.
The doc-sync skill is designed to ensure that the documentation for the IdeaVim project remains accurate and up-to-date in relation to any code changes. This skill addresses the common problem of discrepancies between the codebase and its documentation, which can lead to confusion and errors for users and contributors. By systematically verifying and updating documentation, the skill helps maintain the integrity of the project and supports effective collaboration among developers.
You can use the doc-sync skill by operating in either of its two modes: Documentation to Code Verification or Code Changes to Documentation Update. Follow the specified steps for each mode to ensure synchronization.
The doc-sync skill is specifically tailored for the IdeaVim project and its documentation structure. While it may not directly integrate with other documentation tools, the principles can be adapted for similar projects.
The skill operates based on the current codebase and documentation, so it may not catch issues related to very recent changes if not properly executed. Additionally, it assumes a certain level of familiarity with the code and documentation structure.
Quick Setup:
.claude/skills/Repository
JetBrains/ideavim