update-docs

Update Documentation

Instructions

One-click command to update all project documentation after code changes.

Steps

1. Analyze Changes
2. Check git status for modified files
3. Review recent commits if no uncommitted changes
4. Identify what documentation needs updating

1. Update KNOWLEDGE_BASE.md
2. Run the update-knowledge-base skill
3. Document any architectural or feature changes

1. Update README.md
2. Add new features or commands
3. Update examples if API changed
4. Ensure accuracy of all documented commands

1. Sync README_ZH.md
2. Run the sync-readme skill
3. Ensure Chinese documentation matches English

1. Verify
2. Run tests to ensure nothing broken: npm test
3. Check that all documented commands work
4. Review diff before committing

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