sync-docs

Solid

Use when the user asks to sync, update, or refresh CLAUDE.md, AGENTS.md, SKILL.md, and README.md to reflect recent commits or PRs. Triggers on phrases like "sync docs", "update CLAUDE.md", "update AGENTS.md", "update SKILL.md", "update README", "reflect recent changes", or "document the recent PRs".

AI & Automation 49 stars 8 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
57
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# sync-docs Keep CLAUDE.md, AGENTS.md, SKILL.md, and README.md accurate after new commits land. Finds the last docs-sync point, classifies every commit since then, and writes targeted updates — no rewrite, no drift. Syncing is bidirectional: as well as adding what's new, **remove or correct anything the current codebase now contradicts** — stale paths, renamed symbols, removed fields, dead defaults. A doc that lies is worse than one that's merely incomplete. Adapt to the repo you're in. The doc set below is the common shape, not a requirement — a repo may have only a README, or add its own docs. Edit the files that exist; never create a new top-level doc (AGENTS.md, CHANGELOG.md, SKILL.md) as part of a sync — if one seems warranted, surface it to the user instead. Audience split: - **CLAUDE.md** — agent-facing dense reference (architecture, symbol/file names, `file:line` cues). Describes **current behavior**; not a history log. - **AGENTS.md** *(only if the repo already has one — check `ls -l AGENTS.md` first)* — the counterpart agent doc for other tools (e.g. Codex). A repo keeps it in one of two shapes. As a symlink to CLAUDE.md it holds no content of its own, so it needs no edit. As a real file it carries the same body content (architecture, commands, conventions) with a tool-specific intro line, so every CLAUDE.md body edit gets mirrored into it — see step 5. - **SKILL.md** *(only if the repo has one)* — operator-facing imperative guide (config knobs, setup prompts, CL...

Details

Author
richkuo
Repository
richkuo/rk-skills
Created
2 months ago
Last Updated
2 days ago
Language
JavaScript
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category