How do I install the Docs Sync skill?

Run npx skillmds add majiayu000/docs-sync 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 Docs Sync safe to use?

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

Which AI agents work with Docs Sync?

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 Docs Sync free to use?

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

Who published Docs Sync?

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

Docs Sync by majiayu000 — Agent Skill

Name: Docs Sync
Rating: 4.5 (4 reviews)
Author: majiayu000

File contents

Sync User Documentation

Syncs user documentation with changes in design docs to keep them current.

Overview

This skill detects changes in design docs and updates corresponding user documentation by:

Comparing design doc timestamps with user doc timestamps
Identifying which user docs are affected
Regenerating or updating affected sections
Preserving custom user-added content
Updating sync timestamps

Quick Start

Sync all levels for a module:

/docs-sync effect-type-registry

Sync specific level only:

/docs-sync rspress-plugin-api-extractor --level=1

Preview changes without writing:

/docs-sync website --dry-run

How It Works

1. Parse Parameters

module: Module to sync [REQUIRED]
--level: Sync specific level (1=README, 2=repo, 3=site)
--dry-run: Preview changes without writing

2. Detect Changes

Compare timestamps:

Design doc updated field
User doc last modification time
Identify stale user docs (design newer than user docs)

3. Analyze Impact

For each changed design doc:

Determine which user docs it affects
Identify sections that need updates
Check for breaking changes

4. Update User Documentation

Update strategies:

README - Regenerate features, quick start, API overview
Repository Docs - Update affected topic guides
Site Docs - Refresh concept docs and guides

5. Preserve Custom Content

Protect user additions:

Custom examples
Additional sections
Badges and shields
Screenshots and GIFs

6. Update Timestamps

Mark synced docs with current timestamp.

Supporting Documentation

instructions.md - Detailed sync process
examples.md - Sync scenarios and outputs

Success Criteria

✅ Stale docs identified correctly
✅ Affected sections updated
✅ Custom content preserved
✅ Timestamps updated
✅ No broken links introduced

Integration Points

Uses .claude/design/design.config.json
Reads design docs from designDocsPath
Updates files in userDocs paths
Respects quality standards

Related Skills

/docs-generate-readme - Regenerate README
/docs-generate-repo - Regenerate repo docs
/docs-generate-site - Regenerate site docs
/docs-review - Review sync quality

---name: docs-syncdescription: Sync user documentation with design doc changes. Use when design docs have been updated and user docs need to reflect the changes.--- # Sync User Documentation Syncs user documentation with changes in design docs to keep them current. ## Overview This skill detects changes in design docs and updates corresponding user documentation by: 1. Comparing design doc timestamps with user doc timestamps 2. Identifying which user docs are affected 3. Regenerating or updating affected sections 4. Preserving custom user-added content 5. Updating sync timestamps ## Quick Start **Sync all levels for a module:** ```bash /docs-sync effect-type-registry ``` **Sync specific level only:** ```bash /docs-sync rspress-plugin-api-extractor --level=1 ``` **Preview changes without writing:** ```bash /docs-sync website --dry-run ``` ## How It Works ### 1. Parse Parameters - `module`: Module to sync [REQUIRED] - `--level`: Sync specific level (1=README, 2=repo, 3=site) - `--dry-run`: Preview changes without writing ### 2. Detect Changes Compare timestamps: - Design doc `updated` field - User doc last modification time - Identify stale user docs (design newer than user docs) ### 3. Analyze Impact For each changed design doc: - Determine which user docs it affects - Identify sections that need updates - Check for breaking changes ### 4. Update User Documentation Update strategies: - **README** - Regenerate features, quick start, API overview - **Repository Docs** - Update affected topic guides - **Site Docs** - Refresh concept docs and guides ### 5. Preserve Custom Content Protect user additions: - Custom examples - Additional sections - Badges and shields - Screenshots and GIFs ### 6. Update Timestamps Mark synced docs with current timestamp. ## Supporting Documentation - `instructions.md` - Detailed sync process - `examples.md` - Sync scenarios and outputs ## Success Criteria - ✅ Stale docs identified correctly - ✅ Affected sections updated - ✅ Custom content preserved - ✅ Timestamps updated - ✅ No broken links introduced ## Integration Points - Uses `.claude/design/design.config.json` - Reads design docs from `designDocsPath` - Updates files in `userDocs` paths - Respects quality standards ## Related Skills - `/docs-generate-readme` - Regenerate README - `/docs-generate-repo` - Regenerate repo docs - `/docs-generate-site` - Regenerate site docs - `/docs-review` - Review sync quality

Frequently asked questions