lmiranda
395daecda8
Adds automatic documentation drift detection and synchronization: - PostToolUse hook detects when code changes affect docs - Stop hook reminds of pending updates before session ends - /doc-audit command for full project documentation scan - /doc-sync command to batch apply pending updates - doc-analyzer agent for cross-reference analysis - doc-patterns skill for documentation structure knowledge Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
59 lines
1.4 KiB
Markdown
59 lines
1.4 KiB
Markdown
---
|
|
description: Synchronize all pending documentation updates in a single commit
|
|
---
|
|
|
|
# Documentation Sync
|
|
|
|
Apply all pending documentation updates detected by doc-guardian hooks.
|
|
|
|
## Process
|
|
|
|
1. **Review Pending Queue**
|
|
List all documentation drift detected during this session.
|
|
|
|
2. **Batch Updates**
|
|
For each pending item:
|
|
- Show the specific change needed
|
|
- Apply the update
|
|
- Track in change list
|
|
|
|
3. **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
|
|
|
|
4. **Commit Strategy**
|
|
- Stage all doc changes together
|
|
- Single commit: `docs: sync documentation with code changes`
|
|
- Include summary of what was updated in commit body
|
|
|
|
5. **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
|
|
```
|