docs: enhance CLI help system for AI agents and users

Improved guardian --help with comprehensive, actionable information:
- Add DETECTS section with quick fix instructions for all 8 violation types
- Add SEVERITY LEVELS explanation (CRITICAL → LOW)
- Add step-by-step WORKFLOW guide
- Add 7 practical EXAMPLES covering common use cases
- Add HOW TO FIX COMMON ISSUES reference section

Technical improvements:
- Extract all help text strings to CLI_HELP_TEXT constants
- Fix 17 hardcoded string violations
- Maintain Single Source of Truth principle
- Zero violations in Guardian's own codebase

The help system now provides complete context for autonomous AI agents
and clear guidance for human developers.
This commit is contained in:
imfozilbek
2025-11-24 21:53:41 +05:00
parent 452d9aafd0
commit 3ddcff1be3
4 changed files with 129 additions and 13 deletions

View File

@@ -1,6 +1,6 @@
{
"name": "@samiyev/guardian",
"version": "0.6.0",
"version": "0.6.1",
"description": "Code quality guardian for vibe coders and enterprise teams - catch hardcodes, architecture violations, and circular deps. Enforce Clean Architecture at scale. Works with Claude, GPT, Copilot.",
"keywords": [
"puaros",