update-project git:20260726.9b1c2f9A

Immutable. This exact content is served forever at /api/v1/blob/df8569d7c5317fa5.

---
name: update-project
description: Use when updating docs, syncing CLAUDE.md, AGENTS.md, or README.md, fixing stale documentation, or refreshing project rules and skills. Keeps docs aligned with code changes.
license: MIT
allowed-tools: Read Glob Edit Write Bash(git:*)
model: haiku
effort: low
compatibility: Any project with agent docs (CLAUDE.md/AGENTS.md) and/or a README; language-agnostic
metadata:
  short-description: Keep docs in sync with code.
---

You keep project documentation synchronized with recent code changes and git commits.

Run after significant code changes, before a release, or whenever docs may be stale.

Update only what the project actually changed. Verify a claim against the tree before you write it, and leave sections you cannot verify alone.

Detect which agent the project targets and maintain its instruction file accordingly: `CLAUDE.md` (Claude Code), `AGENTS.md` (Codex, OpenCode, and the cross-agent standard), or both. Component directories follow the same split — `.claude/` for Claude Code, `.agents/` for the cross-agent convention.

## Rules Overview

| Rule | Impact | File |
|------|--------|------|
| Agent docs (CLAUDE.md / AGENTS.md / README.md) | HIGH | `rules/agent-docs.md` |
| Components (agents, skills, rules) | MEDIUM | `rules/components.md` |

## Workflow

### Step 1: Detect

- Run `git log --oneline -20` and `git diff` to identify recent changes
- Check which agent instruction files exist (`CLAUDE.md`, `AGENTS.md`) and whether README.md exists (create if missing)
- Scan both `.claude/` and `.agents/` for `agents/*.md`, `skills/*/SKILL.md`, and `rules/*.md` files
- Compare documented instructions against actual project state to find stale sections
- Flag any new tools, removed dependencies, changed paths, or renamed commands

### Step 2: Update

Read the relevant rule file and apply updates:
- `rules/agent-docs.md` for CLAUDE.md / AGENTS.md / README.md changes
- `rules/components.md` for `.claude/` or `.agents/` agents, skills, and rules changes

### Step 3: Validate

- Run project commands mentioned in docs to verify they work
- Check that instructions match current project setup
- Ensure the agent instruction file (CLAUDE.md / AGENTS.md), README.md, agents, skills, and rules complement each other without duplication
- If both CLAUDE.md and AGENTS.md exist, keep shared guidance consistent between them rather than duplicating divergent instructions