Agent skill

update-claude-docs

Update CLAUDE.md documentation files after code changes. Use when user says "update the CLAUDE.md", "sync the docs with my changes", "document what I changed", "update documentation for this package", or after making significant code modifications that should be reflected in project documentation.

Stars 30
Forks 9

Install this agent skill to your Project

npx add-skill https://github.com/Uniswap/ai-toolkit/tree/next/packages/plugins/development-productivity/skills/update-claude-docs

SKILL.md

CLAUDE.md Updater

Quickly synchronize CLAUDE.md files based on staged git changes.

When to Activate

  • After significant code changes
  • User mentions updating documentation
  • Staged changes should be documented
  • New files added that need documentation
  • Dependencies or commands changed

Quick Process

  1. Check Git: Verify in git repository
  2. Get Staged Files: git diff --cached --name-status
  3. Group by CLAUDE.md: Find nearest CLAUDE.md for each file
  4. Analyze Changes: Determine if updates needed
  5. Show Summary: Preview what will be updated
  6. Apply Updates: Write changes with user confirmation

Update Triggers

Updates triggered when:

  • New files added (status 'A')
  • package.json modified
  • project.json modified
  • Significant changes (>50 lines)
  • New exports added

Update Strategies

New Files

markdown
- `path/to/file.ts` - [TODO: Add description]

Dependencies (package.json)

markdown
- **package-name** (version)

Commands (project.json)

markdown
- `nx command project` - [description]

Significant Changes

markdown
- Modified `path/to/file.ts` (N lines changed)

Performance

  • Single git command for detection
  • No external tools required
  • Simple file operations
  • 1-3 seconds typical

Safety

  • Git provides rollback (git restore CLAUDE.md)
  • Single confirmation prompt
  • Non-destructive (adds, doesn't remove)
  • Review with git diff before commit

Usage Modes

Auto-detect (recommended): Analyzes staged changes automatically

Explicit: Update specific path's CLAUDE.md

Best Practices

  1. Stage changes first (git add)
  2. Review updates (git diff **/*CLAUDE.md)
  3. Commit together with related code
  4. Run frequently after significant changes

Expand your agent's capabilities with these related and highly-rated skills.

Uniswap/ai-toolkit

review-plan

Review implementation plans for completeness and feasibility. Use when user says "review this plan before I start", "is this implementation plan complete", "check if this plan aligns with our patterns", "give me feedback on my implementation strategy", or "validate this plan before we execute it".

30 9
Explore
Uniswap/ai-toolkit

plan-implementation

Create implementation plans for features and changes. Use when user says "plan how to implement user authentication", "how should I add dark mode to the app", "what's the best way to refactor the database layer", "create a plan for migrating to the new API", or "I need to implement [feature] - help me plan it out".

30 9
Explore
Uniswap/ai-toolkit

execute-plan

Execute implementation plans step-by-step. Use when user says "execute the plan", "implement the plan we created", "start building based on the plan", "go ahead and implement it", "proceed with the implementation", "execute as a stack", "create a PR stack while implementing", "implement with one PR per step", or references a plan file and wants to begin coding.

30 9
Explore
Uniswap/ai-toolkit

generate-commit-message

Generate well-structured git commit messages. Use when user says "generate commit message", "write a commit", "what should my commit message be", "create commit message for these changes", or needs help crafting conventional commit messages.

30 9
Explore
Uniswap/ai-toolkit

plan-swarm

Refine plans through multi-agent expert discussion. Use when user says "get multiple expert opinions on this plan", "I want different perspectives on this approach", "have the agents discuss this strategy", "refine the plan through collaborative review", or "what would different specialists think about this design".

30 9
Explore
Uniswap/ai-toolkit

create-pr

Create or update pull requests with conventional commits. Use when user says "create a PR for these changes", "submit this for review", "open a pull request", "push these changes and create a PR", "I'm ready to submit this work", or "create PR and link to issue

30 9
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results