Restructure documentation: Create focused guide ecosystem from oversized user guide

- Transform 28K+ token superclaude-user-guide.md into 4.5K token overview (84% reduction)
- Extract specialized guides: examples-cookbook.md, troubleshooting-guide.md, best-practices.md, session-management.md, technical-architecture.md
- Add comprehensive cross-references between all guides for improved navigation
- Maintain professional documentation quality with technical-writer agent approach
- Remove template files and consolidate agent naming (backend-engineer → backend-architect, etc.)
- Update all existing guides with cross-references and related guides sections
- Create logical learning paths from beginner to advanced users
- Eliminate content duplication while preserving all valuable information

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK
2025-08-15 21:30:29 +02:00
parent 9a5e2a01ff
commit 40840dae0b
91 changed files with 7666 additions and 15055 deletions

View File

@@ -8,7 +8,7 @@ We take security seriously. If you discover a security vulnerability in SuperCla
**Please do NOT create public GitHub issues for security vulnerabilities.**
Instead, email us directly at: `security@superclaude.dev` (or create a private GitHub Security Advisory)
Instead, email us directly at: `anton.knoery@gmail.com` (or create a private GitHub Security Advisory)
### What to Include
@@ -35,7 +35,7 @@ When reporting a vulnerability, please provide:
- Data exfiltration or unauthorized access to sensitive information
### High (Fix within 1 week)
- Local code execution through hook manipulation
- Local code execution through framework component manipulation
- Unauthorized file system access beyond intended scope
- Authentication bypass in MCP server communication
@@ -59,12 +59,12 @@ When reporting a vulnerability, please provide:
## 🛡️ Security Features
### Hook Execution Security (V4 Enhanced)
- **Timeout protection**: All hooks have configurable timeouts (default 30s)
- **Input validation**: JSON schema validation for all hook inputs
- **Sandboxed execution**: Hooks run with limited system permissions
- **Error containment**: Hook failures don't affect framework stability
- **Performance monitoring**: Real-time hook execution tracking
### Framework Component Security (V4 Enhanced)
- **Timeout protection**: All components have configurable timeouts (default 30s)
- **Input validation**: JSON schema validation for all component inputs
- **Sandboxed execution**: Components run with limited system permissions
- **Error containment**: Component failures don't affect framework stability
- **Performance monitoring**: Real-time component execution tracking
- **Session lifecycle integration**: Secure checkpoint and recovery
### File System Protection
@@ -119,12 +119,12 @@ ls -la ~/.claude/
#### Regular Maintenance
- **Update regularly**: Keep SuperClaude and dependencies current
- **Review logs**: Check `~/.claude/` for suspicious activity
- **Monitor permissions**: Ensure hooks have minimal required permissions
- **Monitor permissions**: Ensure components have minimal required permissions
- **Validate configurations**: Use provided schemas to validate settings
### For Developers
#### Hook Development
#### Component Development
```python
# Always validate inputs
def validate_input(data: Dict[str, Any]) -> bool:
@@ -182,7 +182,7 @@ Currently, we don't have a formal bug bounty program, but we recognize security
## 📞 Contact Information
### Security Team
- **Email**: `security@superclaude.dev`
- **Email**: `anton.knoery@gmail.com`
- **PGP Key**: Available on request
- **Response Time**: 48 hours maximum
@@ -206,7 +206,7 @@ For general security questions (not vulnerabilities):
---
**Last Updated**: February 2025 (V4 Beta)
**Next Review**: May 2025
**Last Updated**: August 2025 (V4 Beta)
**Next Review**: November 2025
Thank you for helping keep SuperClaude Framework secure! 🙏