lmiranda
1dad393eaf
The PostToolUse hook was causing workflow interruptions because:
1. Actionable language ("update needed") triggered Claude to seek confirmation
2. Rapid edits (4+ in sequence) generated multiple notifications
Changes:
- Message changed from "update needed" to "drift queued" (passive, informational)
- Added 5-second debouncing: same-type edits within window are silently queued
- Added queue clearing step to doc-sync.md command
Note: Issue #287 also mentions URL restriction behavior, but this was not
found in the current codebase - may have been a different component or
already fixed. Marking as partial fix.
Fixes #287
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2.2 KiB
2.2 KiB
description
| description |
|---|
| Synchronize all pending documentation updates in a single commit |
Documentation Sync
Apply all pending documentation updates detected by doc-guardian hooks.
Visual Output
When executing this command, display the plugin header:
┌──────────────────────────────────────────────────────────────────┐
│ 📝 DOC-GUARDIAN · Documentation Sync │
└──────────────────────────────────────────────────────────────────┘
Then proceed with the sync.
Process
-
Review Pending Queue List all documentation drift detected during this session.
-
Batch Updates For each pending item:
- Show the specific change needed
- Apply the update
- Track in change list
-
Update Types
Reference Fixes:
- Renamed function/class → update all doc references
- Changed signature → update parameter documentation
- Removed item → remove or mark deprecated in docs
Content Sync:
- Version numbers (Python, Node, dependencies)
- Configuration keys/values
- File paths and directory structures
- Command examples and outputs
Structural:
- Add missing sections for new features
- Remove sections for deleted features
- Reorder to match current code organization
-
Commit Strategy
- Stage all doc changes together
- Single commit:
docs: sync documentation with code changes - Include summary of what was updated in commit body
-
Clear Queue After successful sync, clear the queue file:
echo "# Doc Guardian Queue - cleared after sync on $(date +%Y-%m-%d)" > .doc-guardian-queue -
Output
## Documentation Sync Complete
### Files Updated
- README.md (3 changes)
- CLAUDE.md (1 change)
- src/api/README.md (2 changes)
### Changes Applied
- Updated function reference: calculate_total → compute_total
- Updated Python version: 3.9 → 3.11
- Added docstring to create_order()
Committed: abc123f