Claude-skill-registry docs-sync

Sync user documentation with design doc changes. Use when design docs

install

source · Clone the upstream repo

git clone https://github.com/majiayu000/claude-skill-registry

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/majiayu000/claude-skill-registry "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/data/docs-sync" ~/.claude/skills/majiayu000-claude-skill-registry-docs-sync-fca20e && rm -rf "$T"

manifest: skills/data/docs-sync/SKILL.md

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