Skip to content
Back to skills

Sync Docs

ASecurity

Sync official Anthropic documentation and analyze impact on project components. Runs docs/reference/update-claude-docs.sh, computes diffs, and reports impacts on the skill validator, plugins, and project documentation. Use when user mentions "sync docs", "update reference docs", "refresh docs", or "check doc changes".

  • 21 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added May 28, 2026
ai-agentsbashdocumentation

Works with

  • mcp

Security analysis

A100/100

Pro scans all 5 files and shows the line behind each finding

Scanned May 28, 2026

npx -y skills add joaquimscosta/arkhe-claude-plugins --skill sync-docs --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Sync Docs?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Sync Docs
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/joaquimscosta-sync-docs/badge)](https://www.skillsdirectory.com/skills/joaquimscosta-sync-docs)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: sync-docs
description: >
  Sync official Anthropic documentation and analyze impact on project components.
  Runs docs/reference/update-claude-docs.sh, computes diffs, and reports impacts
  on the skill validator, plugins, and project documentation. Use when user
  mentions "sync docs", "update reference docs", "refresh docs", or "check doc changes".
argument-hint: [--dry-run]
---

# Sync Docs

Sync official Anthropic documentation into `docs/reference/` and produce an impact analysis report.

## Quick Start

Run the sync and diff script:

```bash
scripts/sync_and_diff.py
```

Preview changes without overwriting:

```bash
scripts/sync_and_diff.py --dry-run
```

## Execution

### Phase 1: Sync & Diff

1. Execute `scripts/sync_and_diff.py` (or with `--dry-run` if `$ARGUMENTS` contains `--dry-run`)
2. Parse the JSON output from stdout
3. Display a summary table of changed/unchanged files

### Phase 2: Impact Analysis

For each **changed** file, perform the following analysis. See [WORKFLOW.md](WORKFLOW.md) for detailed steps.

#### 2a. Skill Validator Impact (CRITICAL priority)

Check `discrepancies` in the JSON output:

- **`skill_frontmatter_keys.in_docs_not_validator`** (CRITICAL): New fields in SKILLS.md the validator will reject as unknown (FM009). Report exact fields and line in `validate_skill.py` to update (`ALLOWED_FRONTMATTER_KEYS`, ~line 151).
- **`skill_frontmatter_keys.in_validator_not_docs`** (WARNING): Fields the validator allows but SKILLS.md no longer documents. May be from SUBAGENTS.md (valid for `context: fork`) or deprecated.
- **`subagent_frontmatter_keys`** (INFO): New subagent fields from SUBAGENTS.md. Not all are valid in skill frontmatter — report for context. Only flag fields that overlap with skill usage (e.g., `maxTurns`, `mcpServers`, `memory`, `skills`).
- **`hook_events.in_docs_not_validator`** (CRITICAL): New hook events the validator will reject (HK001). Report the line to update (`VALID_HOOK_EVENTS`, ~line 1021).
- **`hook_events.in_validator_not_docs`** (WARNING): Hook events the validator knows but docs no longer list.
- **`memory_scopes`**: Review manually if SUBAGENTS.md changed — check if memory scope options expanded.

#### 2b. Plugin Component Impact (WARNING priority)

For each changed synced doc, identify the conceptual areas that changed (new fields, deprecated features, renamed concepts). Then:

1. Use Grep to search `plugins/*/` for references to changed concepts
2. Flag plugins using deprecated patterns
3. Note new capabilities not yet leveraged (as INFO)

#### 2c. Project Documentation Impact (WARNING priority)

Check these files for stale references to synced doc content:

- `CLAUDE.md` — Plugin Component Guidelines section, Key Documentation Files section
- `docs/README.md` — Synced Documentation section, learning paths
- `docs/SKILL_DEVELOPMENT_BEST_PRACTICES.md` — Frontmatter reference, patterns

## Output Format

Present findings as a structured report:

```
=== Documentation Sync Impact Report ===

## Sync Summary
| File | Status | +Lines | -Lines | New Sections | Removed Sections |
|------|--------|--------|--------|--------------|-----------------|
...

## CRITICAL: Skill Validator Updates Required
(List each discrepancy with file, line number, and fix)

## WARNING: Plugin Components Affected
(List affected plugins and what changed)

## WARNING: Project Documentation Stale
(List affected doc files and what to update)

## INFO: New Capabilities Available
(List new features from updated docs that could be leveraged)
```

If no files changed, report: "All documentation is up to date. No impacts detected."

## References

- [WORKFLOW.md](WORKFLOW.md) — Detailed impact analysis steps
- [EXAMPLES.md](EXAMPLES.md) — Example report outputs
- [TROUBLESHOOTING.md](TROUBLESHOOTING.md) — Common issues

Files in this skill

  • EXAMPLES.md4.6 KB
  • SKILL.md3.7 KB
  • TROUBLESHOOTING.md3.2 KB
  • WORKFLOW.md5.3 KB
  • scripts/sync_and_diff.py17.6 KB

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.