# Update Docs

> Update all project documentation after code changes. Use when this capability is needed.

- Skill: `tomevault-io/update-docs-8` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/update-docs-8`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/update-docs-8/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/update-docs-8

---


# Update Documentation

## Instructions

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

### Steps

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

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

3. **Update README.md**
   - Add new features or commands
   - Update examples if API changed
   - Ensure accuracy of all documented commands

4. **Sync README_ZH.md**
   - Run the `sync-readme` skill
   - Ensure Chinese documentation matches English

5. **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

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/lbb00) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-11 -->