Update docs
Update all project documentation after code changes.From its SKILL.md
npx -y skills add lbb00/ai-rules-sync --skill update-docsAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- runs commandsInstructs the agent to run 1 command, including `npm test`.
SKILL.md
1.3 KB, 281 tokens by cl100k_base, as published. Nobody here has run it
Update Documentation
Instructions
One-click command to update all project documentation after code changes.
Steps
-
Analyze Changes
- Check git status for modified files
- Review recent commits if no uncommitted changes
- Identify what documentation needs updating
-
Update KNOWLEDGE_BASE.md
- Run the
update-knowledge-baseskill - Document any architectural or feature changes
- Run the
-
Update README.md
- Add new features or commands
- Update examples if API changed
- Ensure accuracy of all documented commands
-
Sync README_ZH.md
- Run the
sync-readmeskill - Ensure Chinese documentation matches English
- Run the
-
Verify
- Run tests to ensure nothing broken:
npm test - Check that all documented commands work
- Review diff before committing
- Run tests to ensure nothing broken:
When to Use
- After adding a new adapter
- After adding or modifying CLI commands
- After changing the configuration format
- After any user-facing changes
Output
All documentation files updated and in sync:
- KNOWLEDGE_BASE.md (if exists)
- README.md
- README_ZH.md
Examples
Request: Update all docs after adding OpenCode support Result: KNOWLEDGE_BASE.md, README.md, and README_ZH.md all updated
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.