update-docs · rerun-build — Claude Code skill for documentation updates
The update-docs Claude Code skill checks Rerun’s documentation against code changes. It runs before work is marked done or a pull request is opened for changes to specified project areas, and on direct requests to update the docs.
AGPL-3.0 ★ 1,120 updated 2026-11-16
npx skills add rerun-build/rerun --skill update-docs -a claude-codeWhat update-docs does
The skill reads the branch diff and finds pages in apps/docs, READMEs, and apps/engine/docs that no longer match the code or are missing. It adds, edits, or removes those files in the same pull request as the code change, using values read from the code. For diffs limited to refactors, tests, or internal identifier renames, it says to note in the PR that no docs change is needed.
New pages need an entry in apps/docs/docs.json; removed pages need a redirect there. Before running pnpm check:docs, the skill asks where to run it. Visible pages can be previewed with pnpm dev:docs at http://localhost:3333. The site deploys from master, so the docs should describe the branch’s changes rather than the current production version.
What it helps with
- find documentation pages affected by a branch diff
- update READMEs and site pages in the code-change PR
- remove docs for deleted features
- find links that use renamed heading anchors
Example prompts for the agent
- Update the docs for changes in
apps/uibefore opening a PR. - Check whether the docs still match the changes to
docker-compose.yml. - Compare the Rerun docs with this branch diff and list the pages to edit.
How to install update-docs
1Skills CLI (Vercel)
npx skills add rerun-build/rerun --skill update-docs -a claude-code2Manually: put the files in place
~/.claude/skills/update-docs/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/update-docs/
1Skills CLI (Vercel)
npx skills add rerun-build/rerun --skill update-docs -a codex2Manually: put the files in place
.agents/skills/update-docs/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add rerun-build/rerun --skill update-docs -a cursor2Manually: put the files in place
.cursor/skills/update-docs/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install rerun-build/rerun .claude/skills/update-docs2Manually: put the files in place
.github/skills/update-docs/SKILL.md1Skills CLI (Vercel)
npx skills add rerun-build/rerun --skill update-docs -a gemini-cli2Platform CLI
gemini skills install https://github.com/rerun-build/rerun --path .claude/skills/update-docsManually: put the files in place
.devin/skills/update-docs/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about update-docs
How do I install update-docs in Claude Code?
Run npx skills add rerun-build/rerun --skill update-docs -a claude-code. The skill file is at ~/.claude/skills/update-docs/SKILL.md.
What does update-docs do?
It compares branch changes with Rerun’s documentation and updates affected pages in the same pull request as the code. It covers the site, READMEs, and engine docs.
When does update-docs run?
It runs before work is marked complete or a PR is opened when specified project areas change, including apps/ui, apps/engine, apps/mobile, .env.example, and supabase/migrations. A direct request to update or check the docs also triggers it.
Similar skills
All skills for Writing and docs →update-docs by other authors comes first.