What files get updated?

KNOWLEDGE_BASE.md (if it exists), README.md, and README_ZH.md to keep English and Chinese docs in sync.

Which commands does it run?

It runs update-knowledge-base, sync-readme, and npm test as part of verification.

How do I run update-docs manually?

Use the update-docs skill via your normal command interface; it performs all steps automatically and ensures docs reflect code changes.

update-docs

Scanned

npx machina-cli add skill lbb00/ai-rules-sync/update-docs --openclaw

Files (1)

SKILL.md

1.3 KB

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-base skill
- Document any architectural or feature changes
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-readme skill
- Ensure Chinese documentation matches English
Verify
- Run tests to ensure nothing broken: npm test
- Check that all documented commands work
- 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

Source

git clone https://github.com/lbb00/ai-rules-sync/blob/main/.claude/skills/update-docs/SKILL.mdView on GitHub

Overview

The update-docs skill automates refreshing all project documentation after code changes. It analyzes what changed, updates the knowledge base and READMEs, syncs translations, and verifies commands and tests to keep docs in sync with the codebase.

How This Skill Works

It begins by inspecting git status to detect modified files and determine which docs need updates. It then triggers dedicated tasks (update-knowledge-base and sync-readme), updates KNOWLEDGE_BASE.md, README.md, and README_ZH.md as needed, and finally runs tests to confirm that documented commands still work before committing.

When to Use It

After adding a new adapter
After adding or modifying CLI commands
After changing the configuration format
After any user-facing changes
Before releasing to ensure all docs stay in sync

Quick Start

Step 1: Analyze Changes
Step 2: Update KNOWLEDGE_BASE.md, README.md, and README_ZH.md as needed
Step 3: Verify with tests and review diffs before committing

Best Practices

Work in a clean git working tree and review diffs before committing
Run npm test to ensure nothing is broken and commands still work
Update KNOWLEDGE_BASE.md for architectural or feature changes
Keep README.md updated with new features or commands and updated examples
Ensure README_ZH.md remains in sync with the English version

Example Use Cases

Request: Update all docs after adding OpenCode support -> Result: KNOWLEDGE_BASE.md, README.md, and README_ZH.md all updated
Request: After adding a new adapter -> Result: docs reflect the new adapter's usage and configuration
Request: After CLI command changes -> Result: command examples and flags updated across READMEs
Request: After configuration format changes -> Result: config docs and examples aligned
Request: Before a release -> Result: all docs reviewed, translated, and in sync

Frequently Asked Questions

Add this skill to your agents