mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-17 17:56:46 +00:00
9e685b7326
* ✨ Enhance documentation with advanced markdown formatting Major improvements to documentation presentation and usability: README.md: - Added centered hero section with framework statistics dashboard - Created visual support section with donation cards - Enhanced What's New section with feature grid layout - Reorganized documentation links into categorized table - Added professional badges and visual separators installation.md: - Centered title with platform badges and quick navigation - Consolidated 4 installation methods into unified table - Created visual requirement cards (Required vs Optional) - Added collapsible troubleshooting sections - Removed 3 duplicate "What's Next" sections - Enhanced learning journey with progression tables quick-start.md: - Added visual framework architecture flow diagram - Created component statistics dashboard (21|14|6|6) - Built comparison table for SuperClaude vs Standard Claude - Added 4-week learning timeline with milestones - Enhanced workflow patterns with step-by-step tables - Created key insights cards explaining framework philosophy All documents now feature consistent styling with centered titles, organized tables, emojis for visual scanning, and improved navigation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🔥 Remove outdated publishing and release instruction files Cleaned up repository by removing: - PUBLISHING.md: Outdated publishing guidelines - RELEASE_INSTRUCTIONS.md: Old release process documentation These files are no longer needed as the project has evolved and the processes have been streamlined or moved elsewhere. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🐛 Fix component validation to check metadata file instead of settings.json Resolves #291 - Validation errors after V4 upgrade ## Changes - Fixed validation logic to check .superclaude-metadata.json instead of settings.json - Standardized all component versions to 4.0.4 across the framework - Fixed agent validation to check for correct filenames (architect vs specialist/engineer) - Cleaned up metadata file structure for consistency ## Technical Details The issue was caused by components registering in .superclaude-metadata.json but validation checking settings.json for component registration. This mismatch caused false validation errors even though components were properly installed. ## Testing All components now validate successfully with the corrected logic. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🔖 Bump version to 4.0.6 across entire project ## Summary Comprehensive version update from 4.0.4 to 4.0.6 with validation fixes ## Changes - Updated VERSION file, pyproject.toml, and package.json - Updated all Python __version__ declarations (8 occurrences) - Updated all component metadata versions (6 components, 25+ occurrences) - Updated documentation and README version badges (11 files) - Fixed package.json inconsistency (was 4.0.5) - Updated legacy backup.py version reference (was 3.0.0) - Added CHANGELOG entry for version 4.0.6 ## Files Modified (26 total) - Core: VERSION, pyproject.toml, package.json - Python: SuperClaude/__init__.py, __main__.py, setup/__init__.py, cli/base.py - Components: core.py, commands.py, agents.py, mcp.py, mcp_docs.py, modes.py - Docs: README.md, CONTRIBUTING.md, SECURITY.md, installation.md, quick-start.md - Config: features.json, backup.py, update.py - User: ~/.claude/.superclaude-metadata.json ## Verification All version references now consistently show 4.0.6 Historical references in CHANGELOG preserved as intended 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 📝 Update README.md installation instructions --------- Signed-off-by: NomenAK <39598727+NomenAK@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
SuperClaude Documentation
🎯 Essential Understanding
SuperClaude is a Context Framework for Claude Code - it installs behavioral instruction files that Claude Code reads to enhance its capabilities.
How It Works
- Installation: Python CLI installs context files to
~/.claude/ - Commands: Type
/sc:analyze→ Claude Code readsanalyze.mdinstruction file - Behavior: Claude adopts behaviors defined in context files
- Result: Enhanced development workflows through context switching
🚀 Quick Start (5 Minutes)
New Users: Quick Start Guide →
# Recommended for Linux/macOS
pipx install SuperClaude && SuperClaude install
# Traditional method
pip install SuperClaude && SuperClaude install
# Then try: /sc:brainstorm "web app idea" in Claude Code
Having Issues: Quick Fixes → | Troubleshooting →
📚 Documentation Structure
🌱 Start Here (New Users)
| Guide | Purpose |
|---|---|
| Quick Start | Setup and first commands |
| Installation | Detailed setup instructions |
| Commands Guide | All 21 /sc: commands |
🌿 Daily Usage (Regular Users)
| Guide | Purpose | Use For |
|---|---|---|
| Commands Guide | Master all /sc: commands |
Daily development |
| Agents Guide | 14 domain specialists (@agent-*) |
Expert assistance |
| Flags Guide | Command behavior modification | Optimization |
| Modes Guide | 5 behavioral modes | Workflow optimization |
🌲 Reference & Advanced (Power Users)
| Guide | Purpose | Use For |
|---|---|---|
| Troubleshooting | Problem resolution | When things break |
| Examples Cookbook | Practical usage patterns | Learning workflows |
| MCP Servers | 6 enhanced capabilities | Advanced features |
🔧 Development & Contributing
| Guide | Purpose | Audience |
|---|---|---|
| Technical Architecture | System design | Contributors |
| Contributing | Development workflow | Developers |
🔑 Key Concepts
What Gets Installed
- Python CLI Tool - Manages framework installation
- Context Files -
.mdbehavioral instructions in~/.claude/ - MCP Configurations - Optional external tool settings
Framework Components
- 21 Commands (
/sc:*) - Workflow automation patterns - 14 Agents (
@agent-*) - Domain specialists - 5 Modes - Behavioral modification patterns
- 6 MCP Servers - Optional external tools
🚀 Quick Command Reference
In Your Terminal (Installation)
# Install framework (choose one)
pipx install SuperClaude # Recommended for Linux/macOS
pip install SuperClaude # Traditional method
npm install -g @bifrost_inc/superclaude # Cross-platform
# Configure and maintain
SuperClaude install # Configure Claude Code
SuperClaude update # Update framework
python3 -m SuperClaude --version # Check installation
In Claude Code (Usage)
/sc:brainstorm "project idea" # Start new project
/sc:implement "feature" # Build features
/sc:analyze src/ # Analyze code
@agent-python-expert "optimize this" # Manual specialist
@agent-security "review authentication" # Security review
📊 Framework vs Software Comparison
| Component | Type | Where It Runs | What It Does |
|---|---|---|---|
| SuperClaude Framework | Context Files | Read by Claude Code | Modifies AI behavior |
| Claude Code | Software | Your computer | Executes everything |
| MCP Servers | Software | Node.js processes | Provide tools |
| Python CLI | Software | Python runtime | Manages installation |
🔄 How Everything Connects
User Input → Claude Code → Reads SuperClaude Context → Modified Behavior → Enhanced Output
↓
May use MCP Servers
(if configured)
🆘 Getting Help
Quick Issues (< 2 min): Common Issues →
Complex Problems: Full Troubleshooting Guide →
Installation Issues: Installation Guide →
Command Help: Commands Guide →
Community Support: GitHub Discussions
🤔 Common Misconceptions Clarified
❌ "SuperClaude is an AI assistant"
✅ SuperClaude is a configuration framework that enhances Claude Code
❌ "I'm running SuperClaude"
✅ You're running Claude Code with SuperClaude context loaded
❌ "Claude Code executes; SuperClaude provides context my commands"
✅ Claude Code executes everything; SuperClaude provides the instructions
❌ "The .md files are documentation"
✅ The .md files ARE the framework - active instruction sets
Remember: SuperClaude enhances Claude Code through context - it doesn't replace it or run alongside it. Everything happens within Claude Code itself.