# update-docs

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.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 1120 repo stars
- Author: rerun-build
- License: AGPL-3.0 · policy=link-only · description only; the file stays with the author
- Source: https://github.com/rerun-build/rerun/tree/HEAD/.claude/skills/update-docs/SKILL.md
- Updated: 2026-11-16
- Security check: automated, 2026-11-17 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/rerun-build-update-docs

## What it 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.

## Requirements
- Works with: Supabase, Docker

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add rerun-build/rerun --skill update-docs -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/update-docs/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/update-docs/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add rerun-build/rerun --skill update-docs -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/update-docs/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add rerun-build/rerun --skill update-docs -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/update-docs/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install rerun-build/rerun .claude/skills/update-docs
```

2. **Manually: put the files in place**
- File: `.github/skills/update-docs/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add rerun-build/rerun --skill update-docs -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/rerun-build/rerun --path .claude/skills/update-docs
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/update-docs/SKILL.md` — The legacy .windsurf/skills/ path still works

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/rerun-build/rerun/tree/HEAD/.claude/skills/update-docs/SKILL.md

## When to use it
- 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
- Update the docs for changes in `apps/ui` before 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.

## Similar
- [skillshare-update-docs](https://affpapa.org/en/nevibecode/skills/skillshare-update-docs.md) — skill · ★ 3269 repo stars
- [update-project-docs](https://affpapa.org/en/nevibecode/skills/update-project-docs.md) — skill · ★ 1198 repo stars
- [update-docs-on-code-change](https://affpapa.org/en/nevibecode/rules/update-docs-on-code-change.md) — rule · ★ 41430 repo stars
- [docker-docs](https://affpapa.org/en/nevibecode/skills/docker-docs.md) — skill · 623 installs
- [gsd-docs-update](https://affpapa.org/en/nevibecode/skills/gsd-docs-update.md) — skill · 576 installs
- [dev-docs-update](https://affpapa.org/en/nevibecode/commands/dev-docs-update.md) — command · ★ 10055 repo stars

## Other versions with the same name
- [update-docs · neolabhq](https://affpapa.org/en/nevibecode/skills/update-docs.md) — 1400 installs
- [update-docs · alexj11324](https://affpapa.org/en/nevibecode/skills/alexj11324-update-docs.md) — ★ 88 repo stars

From the same set: [rerun-build/rerun](https://affpapa.org/en/nevibecode/by/rerun-build/rerun.md) — 25 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
