docs: Complete Framework-Hooks documentation overhaul

Major documentation update focused on technical accuracy and developer clarity:

Documentation Changes:
- Rewrote README.md with focus on hooks system architecture
- Updated all core docs (Overview, Integration, Performance) to match implementation
- Created 6 missing configuration docs for undocumented YAML files
- Updated all 7 hook docs to reflect actual Python implementations
- Created docs for 2 missing shared modules (intelligence_engine, validate_system)
- Updated all 5 pattern docs with real YAML examples
- Added 4 essential operational docs (INSTALLATION, TROUBLESHOOTING, CONFIGURATION, QUICK_REFERENCE)

Key Improvements:
- Removed all marketing language in favor of humble technical documentation
- Fixed critical configuration discrepancies (logging defaults, performance targets)
- Used actual code examples and configuration from implementation
- Complete coverage: 15 configs, 10 modules, 7 hooks, 3 pattern tiers
- Based all documentation on actual file review and code analysis

Technical Accuracy:
- Corrected performance targets to match performance.yaml
- Fixed timeout values from settings.json (10-15 seconds)
- Updated module count and descriptions to match actual shared/ directory
- Aligned all examples with actual YAML and Python implementations

The documentation now provides accurate, practical information for developers
working with the Framework-Hooks system, focusing on what it actually does
rather than aspirational features.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK
2025-08-06 15:13:07 +02:00
parent ff7eda0e8a
commit 9edf3f8802
52 changed files with 4990 additions and 10202 deletions

View File

@@ -20,13 +20,13 @@ The logging configuration serves as:
#### Basic Configuration
```yaml
logging:
enabled: true
level: "INFO" # ERROR, WARNING, INFO, DEBUG
enabled: false
level: "ERROR" # ERROR, WARNING, INFO, DEBUG
```
**Purpose**: Controls overall logging enablement and verbosity level
**Levels**: ERROR (critical only) → WARNING (issues) → INFO (operations) → DEBUG (detailed)
**Default**: INFO provides optimal balance of information and performance
**Default**: Disabled by default with ERROR level when enabled to minimize overhead
#### File Settings
```yaml
@@ -43,16 +43,16 @@ file_settings:
#### Hook Logging Settings
```yaml
hook_logging:
log_lifecycle: true # Log hook start/end events
log_decisions: true # Log decision points
log_errors: true # Log error events
log_timing: true # Include timing information
log_lifecycle: false # Log hook start/end events
log_decisions: false # Log decision points
log_errors: false # Log error events
log_timing: false # Include timing information
```
**Lifecycle Logging**: Tracks hook execution start/end for performance analysis
**Decision Logging**: Records key decision points for debugging and learning
**Error Logging**: Comprehensive error capture with context preservation
**Timing Logging**: Performance metrics for optimization and monitoring
**Lifecycle Logging**: Disabled by default for performance
**Decision Logging**: Disabled by default to reduce overhead
**Error Logging**: Disabled by default (can be enabled for debugging)
**Timing Logging**: Disabled by default to minimize performance impact
#### Performance Settings
```yaml
@@ -158,12 +158,12 @@ subagent_stop:
```yaml
development:
verbose_errors: true
verbose_errors: false
include_stack_traces: false # Keep logs clean
debug_mode: false
```
**Verbose Errors**: Provides detailed error messages for troubleshooting
**Verbose Errors**: Disabled by default for minimal output
**Stack Traces**: Disabled by default to keep logs clean and readable
**Debug Mode**: Disabled for production performance, can be enabled for deep debugging