3 Commits

Author SHA1 Message Date
007b55916c Merge pull request 'Release: doc-guardian README fix' (#85) from development into main 2026-01-22 12:58:20 +00:00
eeef35aa61 Merge pull request 'fix: correct doc-guardian README to match actual implementation' (#84) from fix/doc-guardian-readme-accuracy into development 2026-01-22 12:44:50 +00:00
be2d989899 fix: correct doc-guardian README to match actual implementation
- Remove false claim about Stop hook (was removed in d2ad90d)
- Fix Solution section to accurately describe prompt-based behavior
- Remove misleading "queue" language since there's no persistent queue

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-22 07:42:51 -05:00

View File

@@ -11,10 +11,10 @@ Documentation gets outdated. Functions get renamed, configs change, versions bum
## Solution
doc-guardian watches your code changes and automatically:
1. Detects when changes affect documentation
2. Queues updates silently (doesn't interrupt your flow)
3. Syncs all doc changes in a single commit when ready
doc-guardian monitors your code changes via hooks:
1. Detects when changes might affect documentation
2. Alerts you to potential drift (doesn't interrupt your flow)
3. Provides commands to audit and sync docs when ready
## Commands
@@ -25,8 +25,7 @@ doc-guardian watches your code changes and automatically:
## Hooks
- **PostToolUse (Write\|Edit)**: Silently checks if code changes affect docs
- **Stop**: Reminds you of pending doc updates before session ends
- **PostToolUse (Write|Edit)**: Silently checks if code changes affect docs
## What It Detects