doc-update
Skill45 starsChanged 52 days agoMITView on GitHub
Check Scraps' documentation against what a release shipped, propose the updates it is missing, and apply the ones the user picks. Use this after a release is published (e.g. "/doc-update 3.1.0", "v3.1.0 の docs を見直して"), or whenever the user asks whether the docs site, README or plugin READMEs still match released behaviour.
8 other projects use a version of this.
Adopted by
Most recently taken up by
- TidalPaladin/skillstheir own version, first seen Nov 8, 2026
- drvoss/everything-copilot-clitheir own version, first seen Oct 26, 2026
- vardan6/tracklinetheir own version, first seen Oct 16, 2026
- ChrisSteinbach/claude-skillstheir own version, first seen Oct 15, 2026
- illegalstudio/elephctheir own version, first seen Oct 8, 2026
- x0c/agent-doc-skillstheir own version, first seen Sep 23, 2026
Other versions8 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 8
- illegalstudio/elephc★ 812same name
- drvoss/everything-copilot-cli★ 48same name
- vardan6/trackline★ 2same name
- x0c/agent-doc-skills★ 2same name
- x0c/doc-skills★ 2same name
- TidalPaladin/skills★ 1same name
- ChrisSteinbach/claude-skills★ 0same name
- Ekajto/my-claude-skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository12 other files it gives its agents.
- AGENTS.mdAGENTS.md
- ade-rule-dslSkill
- adr-checkSkill
- adr-reviewSkill
- dogfoodSkill
- releaseSkill
- ade-rule-dslSkill
- adr-checkSkill
- adr-reviewSkill
- doc-updateSkill
- dogfoodSkill
- releaseSkill
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.
0
Common
Most of the 8 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 19
Keep what users would notice: breaking changes, features, fixes, and performance changes.
- Very specific: line 50
Check links with the binary built from this checkout: cargo build --release && ./target/release/scraps -C docs lint -r broken-link -r …
“Common” is measured: kept by at least 6 in 10 of the 8 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Doc update
Feature PRs normally update their docs in the same change. This skill looks for what slipped through anyway:
- behaviour the release changed that the docs still describe the old way
- pages where a new feature should appear but doesn't
- screenshots that no longer match
Takes a version such as 3.1.0. Without one, use the latest release (gh release view --json tagName).
1. Read what shipped
gh release view v<version> --json bodylists the PRs by section, with breaking changes first.- Keep what users would notice: breaking changes, features, fixes, and performance changes. Skip maintenance.
- For each PR you keep,
gh pr view <N> --json files --jq '.files[].path'shows which docs it already updated. Don't propose those changes again.
2. Find where each change belongs
| Surface | Where | Holds |
| Docs site | docs/ | A Scraps wiki laid out by Diátaxis in Tutorial/, How-to/, Reference/ and Explanation/. docs/README.md is the index page |
| README | README.md | Quick start, how Scraps works, AI integration, screenshots |
| MCP tool reference | plugins/mcp-server/README.md | Parameters and response shape of every MCP tool |
| Plugin overviews | plugins/*/README.md | What each plugin bundles |
| Screenshots | assets/ | Images the README embeds |
Pages move between releases, so list the tree (git ls-files docs README.md plugins assets) rather than assuming paths. To find everything that mentions a changed command, flag, config key or term, run git grep -n "<term>" -- docs README.md plugins. An exact match catches stale mentions that fuzzy search misses.
Usual homes for a change:
- A command, flag or
--jsonfield:docs/Reference/CLI Overview.md. If agents use it, alsodocs/How-to/Integrate with AI Assistants.md. - A config key:
docs/Reference/Configuration.md - A lint rule:
docs/Reference/Lint Rules.md - An MCP tool:
plugins/mcp-server/README.md - A change in what CI needs, such as checkout depth or action inputs:
docs/How-to/Deploy to GitHub Pages.md - A new major version: every
boykush/scraps@v<major>reference
3. Propose
Group the proposals by file. For each one, give what to add or change, which section it goes in, and the PR that calls for it. List first anything that still describes the old behaviour of a breaking change. Then ask the user which proposals to apply.
4. Apply what the user picks
- Match the page's voice and its wiki-links (
[[Reference/CLI Overview]],#[[Tag]]). Link a new page from the index or from its parent page. For example, pages underReference/Static Site/are linked fromReference/Static Site.md. - Check links with the binary built from this checkout:
cargo build --release && ./target/release/scraps -C docs lint -r broken-link -r broken-heading-ref. - Open the edits as their own docs PR (
docs: ...), separate from the release.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.