Use the doc-curator subagent to surgically update existing documentation in the `docs/` directory based on recent code changes. This command focuses on intelligent, incremental updates to keep documentation synchronized with code changes.
Updates existing documentation based on recent code changes using surgical, incremental updates.
/plugin marketplace add AojdevStudio/dev-utils-marketplace/plugin install documentation@dev-utils-marketplaceUse the doc-curator subagent to surgically update existing documentation in the docs/ directory based on recent code changes. This command focuses on intelligent, incremental updates to keep documentation synchronized with code changes.
DOCS_DIR: docs COMMIT_DEPTH: {{if flags.depth}}{{flags.depth}}{{else}}10{{endif}} FOCUS_AREA: {{if flags.focus}}{{flags.focus}}{{else}}all{{endif}} ANALYZE_MODE: {{if flags.uncommitted}}uncommitted{{else}}all{{endif}}
ls docs/ 2>/dev/null | head -5find docs/ -type f -name "*.md" -o -name "*.rst" -o -name "*.txt" | sortgit status --short | head -20git diff --stat | head -15git diff --cached --stat | head -15git diff --function-context | grep -E "^@@|^\+\+\+|function|class|def|interface" | head -30git log --oneline -COMMIT_DEPTH --name-status | grep -E "^[AM]" | head -20git diff HEAD~COMMIT_DEPTH --stat | head -15git diff HEAD~COMMIT_DEPTH --function-context | grep -E "^@@|^\+\+\+|function|class|def|interface" | head -30Use the doc-curator subagent with specific instructions based on FOCUS_AREA:
Analyze these code changes (both uncommitted and recent commits) and update ONLY the affected sections in existing documentation:
Uncommitted changes:
- [Output from git diff for working directory]
- [Output from git diff --cached for staged changes]
Recent committed changes (if analyzing history):
- [Output from git diff HEAD~COMMIT_DEPTH]
- [Specific functions/APIs that changed]
Documentation focus: FOCUS_AREA
Target directory: docs/
Instructions:
1. Read existing documentation files in docs/
2. Identify which docs reference the changed code
3. Make surgical updates ONLY where needed:
- Update function signatures if they changed
- Update configuration options if modified
- Update API endpoints if altered
- Update example code if it's now incorrect
- Add brief notes for new features
- Mark deprecated features
4. Preserve all other content exactly as is
5. Do NOT rewrite entire sections unless absolutely necessary
6. Focus on accuracy over comprehensive rewrites
Documentation Synchronization Complete
Directory: DOCS_DIR
Commits Analyzed: COMMIT_DEPTH
Focus Area: FOCUS_AREA
Surgical Updates Applied:
Update Summary:
Function Signature Change:
- `processData(input: string): void`
+ `processData(input: string, options?: ProcessOptions): Promise<void>`
Configuration Update:
- `API_TIMEOUT`: 5000 (milliseconds)
+ `API_TIMEOUT`: 10000 (milliseconds, increased for stability)
Deprecated Feature:
+ **Deprecated:** The `oldMethod()` function is deprecated as of v2.0. Use `newMethod()` instead.
/update-docsUpdate implementation documentation including specs, status, and best practices
/update-docsUpdate and maintain project documentation for local code changes using multi-agent workflow with tech-writer agents. Covers docs/, READMEs, JSDoc, and API documentation.