docs-update
Skill1 starsChanged 3 days agoMITView on GitHub
Bring every piece of documentation and distribution text of a project up to date with the changes made (and the latest version) - README, CHANGELOG, docs/ HTML site and project graph, gh-pages branch, GitHub wiki, packages / manifests / version numbers, setup / install scripts, --help and usage texts, completions, man pages, examples, templates, marketplace / plugin lists, CI docs, license year - by finding every place the changes touch, not only the obvious ones. Use whenever the user asks to update / refresh / synchronize the docs, "mets à jour toute la doc / le README / le changelog / le site / le wiki / les packages / le script d'install", after a feature, a fix, a release or a version bump.
18 other projects use a version of this.
Adopted by
Most recently taken up by
- jellydn/my-ai-toolstheir own version, first seen Nov 15, 2026
- microsoft/veronatheir own version, first seen Nov 8, 2026
- buildomator/buildomatortheir own version, first seen Nov 4, 2026
- aka-kika/akakika-skillstheir own version, first seen Nov 1, 2026
- davidanthonyn/claude-skillstheir own version, first seen Oct 20, 2026
- harukikuri/spotnotetheir own version, first seen Oct 20, 2026
Other versions18 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 18
- microsoft/verona★ 3.7ksame name
- warpdotdev/oz-skills★ 825same name
- bagofwords1/bagofwords★ 463same name
- jellydn/my-ai-tools★ 129same name
- hiromaily/go-crypto-wallet★ 128same name
- TangleML/tangle-ui★ 104same name
- buildomator/buildomator★ 102same name
- harukikuri/spotnote★ 25same name
- aka-kika/akakika-skills★ 11same name
- Escoto/RustifyMyClaw★ 8same name
8 more not listed
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 repository70 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- ask-at-endSkill
- clarifySkill
- continue-workSkill
- exportSkill
- full-permissionSkill
- ideationSkill
- interactive-questionsSkill
- onboardSkill
- pauseSkill
- presentationSkill
- rtkSkill
- setup-contextSkill
- write-like-meSkill
- audit-bugsSkill
- audit-depsSkill
- audit-qualitySkill
- audit-securitySkill
- benchmarkSkill
- cmake-styleSkill
- cpp-classSkill
- cpp-commentsSkill
- cpp-projectSkill
- cpp-styleSkill
- better-explain-docSkill
- better-html-docSkill
- better-html-styleSkill
- better-protocol-docSkill
- explain-docSkill
- html-docSkill
- html-styleSkill
- protocol-docSkill
- readme-styleSkill
- reportSkill
- wiki-styleSkill
- ci-cdSkill
- git-commitSkill
- git-conventionsSkill
- pre-commitSkill
- legal-checkSkill
- legal-setupSkill
- licenseSkill
- libutils-exceptionSkill
- libutils-installSkill
- libutils-setupSkill
- libutilsSkill
- python-classSkill
- python-commentsSkill
- python-projectSkill
- python-styleSkill
- auditSkill
- cppSkill
- devSkill
- docSkill
- gitSkill
- legalSkill
- pythonSkill
- setup-projectSkill
- styleSkill
- setup-studioSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 17 edited versions we read keep these.
4
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
- Very specific: line 24
Run scripts/inventory.sh [repo] for the first pass: it lists the documentation surfaces that exist, the versions found, dead links in the …
- Distinctive: line 28
Check each one; skip what the project has not.
- Distinctive: line 50
Check every name / command / option / API against the code: before writing it; mark planned vs implemented.
- Distinctive: line 54
Follow the style skill of each surface.
- Distinctive: line 58
No version bump, tag, release or publication on your own: if the version in the docs must move, say which files and to what, and do it only …
“Common” is measured: kept by at least 6 in 10 of the 17 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
Update all the documentation
Goal: after changes, nothing that describes the project is stale - docs, site, wiki, packages, install scripts, version strings. Think of every place the project is described, not only the README.
1. Baseline: what changed
Find what the docs must catch up with, in this order:
- What the user says changed (the request, the conversation).
- The pending diff (
\git status,\git diff HEAD) and the commits since the last docs update or the last release:\git describe --tags --abbrev=0,\git log <tag>..HEAD --oneline,\git log -1 --format=%H -- README.md CHANGELOG.md docs. - The latest version: the source of truth is the code (
project(... VERSION x.y.z),pyproject.toml,package.json,Cargo.toml, thereference/VERSION.mdof a skill (libutils), the last tag, aversionconstant). Take the newest one found, and report any disagreement between them. For a dependency documented from its upstream (ex: libutils), take its latest release (libutilsskill:scripts/update.sh).
Run scripts/inventory.sh [repo] for the first pass: it lists the documentation surfaces that exist, the
versions found, dead links in the Markdown and what is not committed yet.
2. Inventory every surface that exists
Check each one; skip what the project has not. Do not stop at the first hit.
| Surface | What to bring up to date | Skill |
README.md (+ sub-READMEs of tools / modules) | features, tables, command lists, install, usage, layout tree, badges, versions, links | readme-style |
CHANGELOG.md | new entry for the changes / version (its own commit) | git-conventions |
| Release notes, tag text | the next release body (not published without a request) | git-conventions |
docs/ HTML (user guide, technical doc, project graph) | pages, summaries, numbered cards, graph data regenerated, EN/FR texts, theme | html-doc (+ html-style) |
gh-pages branch / site / packages repository | the published copy of docs, graph, repo metadata, index of packages (worktree or clone, see below) | html-doc, cpp-project |
GitHub wiki (<repo>.wiki.git) | Home version stamp, sidebar, section pages, member tables | wiki-style |
| Packages and manifests | version in CMakeLists.txt, CPack / spec / control, pyproject.toml, package.json, Cargo.toml, plugin / marketplace JSON (names, descriptions, skill lists), Dockerfile labels | cmake-style, python-project |
| Setup / install / update scripts | usage header, command and option lists, list of installable items, URLs, default versions, uninstall paths | coding-style |
--help / usage text, man pages, shell completions | every option and command that exists now | the style skill of the language |
Examples, templates, reference/ files, skill and router tables | outdated names, removed options, new items | the skill's own rules |
| CI / CD docs and workflow comments | job names, keywords, images, versions | ci-cd |
LICENSE / notices | year, holder, third-party notices after a dependency change | license, audit-deps |
| Doxygen / docstrings / code comments describing changed behavior | the stale ones only | comments |
| claude.ai bundles, generated archives, exported files | rebuilt from the sources (never edited by hand) | the project's build script |
3. Update
- For each change, ask "where else is this written?":
grep -rnthe old name, option, path, version and count (ex: "9 routers", a list of skills) over the whole repository, the wiki andgh-pages. - Check every name / command / option / API against the code before writing it; mark planned vs implemented.
- Same list written in several places (README table, layout tree, plugin table, router tables, marketplace JSON, setup script header, claude.ai README): change them all in one pass so they stay identical.
- Generated files are regenerated with their generator (graph, archives, reference from a commit), not edited.
- Follow the style skill of each surface; texts in English unless the project's docs are not.
gh-pagesand the wiki are other branches / repositories: usegit worktree addor a temporary clone, edit there, then remove the worktree / clone and come back on the original branch; leave the result uncommitted unless the user asked for commits (thengit-commitfor each repository).- No version bump, tag, release or publication on your own: if the version in the docs must move, say which files and to what, and do it only when asked.
4. Verify
- Re-run
scripts/inventory.sh: no dead link, versions identical everywhere. - Anchors and tables (
wiki-stylehascheck_wiki.py;html-stylehascheck_style.py, which also checks the responsive rules of the HTML). - The commands written in the docs actually run (
--help, install in a scratch prefix when cheap). - Scripts / builds that read the docs' lists still work (ex: rebuild the archives,
./setup.sh list).
5. Report
List by surface what was changed (path, one line), what was checked and found already current, what could not be
done (private wiki, no network, version decision) and the commit command to suggest (git-commit). A written
summary of a wide pass goes through report only when the user wants a file.
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.

