Template

Files

lmiranda 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

1.4 KiB

Raw Permalink Blame History

doc-guardian

Automatic documentation drift detection and synchronization for Claude Code projects.

Problem Solved

Documentation gets outdated. Functions get renamed, configs change, versions bump—but docs lag behind. This creates:

Multiple review cycles finding stale references
Unnecessary commits fixing docs piecemeal
User confusion from outdated instructions

Solution

doc-guardian monitors your code changes via hooks:

Detects when changes might affect documentation
Alerts you to potential drift (doesn't interrupt your flow)
Provides commands to audit and sync docs when ready

Commands

Command	Description
`/doc-audit`	Full project scan - reports all drift without changing anything
`/doc-sync`	Apply all pending documentation updates in one commit

Hooks

PostToolUse (Write|Edit): Silently checks if code changes affect docs

What It Detects

Broken References: Function/class renamed but docs still use old name
Version Drift: Python 3.9 in docs but 3.11 in pyproject.toml
Missing Docs: Public functions without docstrings
Stale Examples: CLI examples that no longer work

Installation

This plugin is part of the Leo Claude Marketplace.

/plugin marketplace add https://gitea.hotserv.cloud/personal-projects/leo-claude-mktplace.git
/plugin install doc-guardian

Integration

See claude-md-integration.md for CLAUDE.md additions.

1.4 KiB Raw Permalink Blame History