/update-docs | box-factory | ClaudePluginHub

Back to Commands

Slash Command

Community

/update-docs

From box-factory

0

Description

Update or regenerate README and CLAUDE.md documentation for a plugin

AI Summary

Regenerate concise README and CLAUDE.md files for a plugin by analyzing its components. Use this when the plugin structure changes or documentation becomes outdated.

Install

1

Add the repository(one-time)

$

/plugin marketplace add racurry/neat-little-package

2

Install the plugin

$

/plugin install box-factory@neat-little-package

Argument

plugin-path

Command Content

Update documentation for the plugin at $1 (or current directory if not specified).

Process

Read all plugin components:
- plugin.json (metadata)
- All files in agents/, commands/, skills/, hooks/
- Existing README.md and CLAUDE.md (if present)

Load plugin-design skill and read README style guidance:

Use Skill tool: skill="box-factory:plugin-design"
Read: readme-style.md

Generate/update README.md following README style guidance:
- Target ~20 lines total (not 50-100)
- One-liner description
- 2-3 terse bullets in Overview
- Commands in code blocks with inline # comments
- NO Components/Features/Philosophy/Troubleshooting sections
- NO prose explanations - action-focused only
Generate/update CLAUDE.md (only if plugin has conventions):
- Only create if plugin has specific patterns Claude should follow
- Focus on knowledge delta (what Claude wouldn't know)
- Skip if plugin is simple with no special conventions
Ensure accuracy:
- Documentation matches actual implementation
- No speculative or aspirational content
- Remove outdated sections from existing docs

Links

GitHub Stats

0 forks

Updated 26 days ago

Other plugins with /update-docs

Update implementation documentation including specs, status, and best practices

commands-documentation-changelogs

2.2k

Update implementation documentation including specs, status, and best practices

2.2k

Update and maintain project documentation for local code changes using multi-agent workflow with tech-writer agents. Covers docs/, READMEs, JSDoc, and API documentation.

194

Audit and maintain documentation files in the current project. This command checks for stale content, outdated references, redundancy, and suggests improvements.

132

Check and update documentation for LLM consumption.

116