How do I install the Update Documents skill?

Run npx skillmds@latest add tomevault-io/update-documents in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Update Documents safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Update Documents?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Update Documents free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Update Documents?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Update Documents by tomevault-io — Agent Skill

Name: Update Documents
Author: tomevault-io

Update Documents

Synchronizes documentation between CLAUDE.md, README.md, and docs/. Resolves documentation inconsistencies across project files with configurable sync rules and whitespace-tolerant comparison. Use when this capability is needed.

tomevault-io b4502b0 2 files · 3.1 KB Updated Sep 17, 2026

File contents

Update Documentation

Automatically synchronize project documentation between the various documentation files.

Sync Rules

Source	Section	Targets
CLAUDE.md	Tech Stack	README.md, docs/index.md
CLAUDE.md	Development Commands	README.md, docs/development/local-setup.md
CLAUDE.md	Project Structure	README.md
README.md	Quick Start	docs/getting-started/quickstart.md

Principle: CLAUDE.md is the technical source of truth; README.md is the user-facing entry document.

Workflow

1. Run Analysis

First check the current sync status:

cd ${PROJECT_ROOT} && python ${SKILL_DIR}/scripts/main.py --analyze

2. Interpret Output

The script displays:

Synchronized: sections are identical
Outdated: target differs from source
Missing: section does not exist

3. Synchronize When Differences Are Found

If differences were found:

cd ${PROJECT_ROOT} && python ${SKILL_DIR}/scripts/main.py --sync

4. Review Results

After synchronization:

Check the updated files for correct formatting
Ensure no context-specific adjustments were lost
If needed: manual post-processing for target-specific phrasing

5. Output Summary

Provide the user with a brief summary:

Documentation synchronized

Updated:
  - README.md: Tech Stack, Development
  - docs/index.md: Tech Stack

Unchanged:
  - docs/getting-started/quickstart.md

Customize Configuration

The sync rules are defined in ${SKILL_DIR}/config/sync_rules.json.

Add a new rule:

{
  "id": "new-rule",
  "source": {"file": "SOURCE.md", "section": "Section Name"},
  "targets": [
    {"file": "TARGET.md", "section": "Target Section"}
  ]
}

Notes

No automatic commits: The skill only modifies files, it does not commit
Whitespace-tolerant: Minor formatting differences are ignored
Section matching: Case-insensitive heading search
Backup: Create manually before synchronization if needed

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: update-documentsdescription: Synchronizes documentation between CLAUDE.md, README.md, and docs/. Resolves documentation inconsistencies across project files with configurable sync rules and whitespace-tolerant comparison. Use when this capability is needed.---# Update DocumentationAutomatically synchronize project documentation between the various documentation files.## Sync Rules| Source | Section | Targets ||--------|---------|---------|| CLAUDE.md | Tech Stack | README.md, docs/index.md || CLAUDE.md | Development Commands | README.md, docs/development/local-setup.md || CLAUDE.md | Project Structure | README.md || README.md | Quick Start | docs/getting-started/quickstart.md |**Principle:** CLAUDE.md is the technical source of truth; README.md is the user-facing entry document.## Workflow### 1. Run AnalysisFirst check the current sync status:```bashcd ${PROJECT_ROOT} && python ${SKILL_DIR}/scripts/main.py --analyze```### 2. Interpret OutputThe script displays:- Synchronized: sections are identical- Outdated: target differs from source- Missing: section does not exist### 3. Synchronize When Differences Are FoundIf differences were found:```bashcd ${PROJECT_ROOT} && python ${SKILL_DIR}/scripts/main.py --sync```### 4. Review ResultsAfter synchronization:- Check the updated files for correct formatting- Ensure no context-specific adjustments were lost- If needed: manual post-processing for target-specific phrasing### 5. Output SummaryProvide the user with a brief summary:```Documentation synchronizedUpdated: - README.md: Tech Stack, Development - docs/index.md: Tech StackUnchanged: - docs/getting-started/quickstart.md```## Customize ConfigurationThe sync rules are defined in `${SKILL_DIR}/config/sync_rules.json`.Add a new rule:```json{ "id": "new-rule", "source": {"file": "SOURCE.md", "section": "Section Name"}, "targets": [ {"file": "TARGET.md", "section": "Target Section"} ]}```## Notes- **No automatic commits**: The skill only modifies files, it does not commit- **Whitespace-tolerant**: Minor formatting differences are ignored- **Section matching**: Case-insensitive heading search- **Backup**: Create manually before synchronization if needed---> Converted and distributed by [TomeVault](https://tomevault.io/claim/talent-factory) — claim your Tome and manage your conversions.

Frequently asked questions