From be2d9898992c415cd83539a0121a3e9fbca0a7cd Mon Sep 17 00:00:00 2001 From: lmiranda Date: Thu, 22 Jan 2026 07:42:51 -0500 Subject: [PATCH] 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 --- plugins/doc-guardian/README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/plugins/doc-guardian/README.md b/plugins/doc-guardian/README.md index 89a8063..c5c1e91 100644 --- a/plugins/doc-guardian/README.md +++ b/plugins/doc-guardian/README.md @@ -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