personal-projects/leo-claude-mktplace
Template
0
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request 'fix: correct doc-guardian README to match actual implementation' (#84) from fix/doc-guardian-readme-accuracy into development

Browse Source
This commit was merged in pull request #84.
This commit is contained in:
Leo Miranda
2026-01-22 12:44:50 +00:00
parent 0c07820b5a be2d989899
commit eeef35aa61
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
plugins/doc-guardian/README.md
View File

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