External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-17 09:46:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

🔧 Fix command syntax inconsistencies and improve documentation clarity

Browse Source 
## Command Syntax Standardization
- Fix lowercase "superclaude" → "SuperClaude" in installation.md
- Distinguish between terminal commands (SuperClaude install) and Claude Code commands (/sc:*)
- Add clear command context headers to all major documentation files

## Documentation Improvements
- Add command reference tables to key guides
- Create visual distinction markers (🖥️ Terminal vs 💬 Claude Code)
- Update verification sections with proper command separation
- Fix content duplications in Developer-Guide and Getting-Started files

## Cross-Reference Updates
- Standardize all documentation links to use Docs/ prefix structure
- Replace invalid email addresses with anton.knoery@gmail.com
- Remove non-existent team references from security documentation

## Files Enhanced
- Getting-Started: installation.md, quick-start.md with command clarity
- User-Guide: commands.md with comprehensive command context
- Reference: troubleshooting.md, common-issues.md with mixed command support
- Root files: README.md, CONTRIBUTING.md, SECURITY.md link updates

This resolves command confusion between installation (terminal) and development (/sc:) commands.

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK 2025-08-18 12:45:06 +02:00
parent d2f4ef43e4
commit 1eab5e3bc4
20 changed files with 286 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CODE_OF_CONDUCT.md
View File

@ -145,7 +145,7 @@ SuperClaude Framework is committed to fostering an inclusive, professional, and
**Reporting Channels:** **Reporting Channels:**
**Primary Contact:** **Primary Contact:**
- **Email**: conduct@superclaude.org (monitored by conduct team) - **Email**: anton.knoery@gmail.com (monitored by conduct team)
- **Response Time**: 48-72 hours for initial acknowledgment - **Response Time**: 48-72 hours for initial acknowledgment
- **Confidentiality**: All reports treated with appropriate discretion - **Confidentiality**: All reports treated with appropriate discretion
@ -390,7 +390,7 @@ SuperClaude Framework prioritizes education and growth over punishment when addr
### Conduct Team ### Conduct Team
**Conduct Team:** **Conduct Team:**
- **Primary Contact**: conduct@superclaude.org - **Primary Contact**: anton.knoery@gmail.com
- **Team Composition**: Selected maintainers and community members with training in conflict resolution - **Team Composition**: Selected maintainers and community members with training in conflict resolution
- **Response Time**: 48-72 hours for initial acknowledgment - **Response Time**: 48-72 hours for initial acknowledgment
- **Availability**: Monitored continuously with escalation procedures for urgent issues - **Availability**: Monitored continuously with escalation procedures for urgent issues
@ -414,7 +414,7 @@ SuperClaude Framework prioritizes education and growth over punishment when addr
- Regular training updates on best practices for community management - Regular training updates on best practices for community management
**Contact Preferences:** **Contact Preferences:**
- **Email**: conduct@superclaude.org for all formal reports and inquiries - **Email**: anton.knoery@gmail.com for all formal reports and inquiries
- **Anonymous**: Anonymous reporting form available for sensitive situations - **Anonymous**: Anonymous reporting form available for sensitive situations
- **Urgent**: Emergency contact procedures for immediate safety concerns - **Urgent**: Emergency contact procedures for immediate safety concerns
- **Follow-up**: Scheduled check-ins for ongoing cases and policy discussions - **Follow-up**: Scheduled check-ins for ongoing cases and policy discussions
@ -423,7 +423,7 @@ SuperClaude Framework prioritizes education and growth over punishment when addr
**Project Leadership:** **Project Leadership:**
- **Maintainers**: @SuperClaude-Org maintainer team on GitHub - **Maintainers**: @SuperClaude-Org maintainer team on GitHub
- **Issues**: GitHub Issues with `conduct` or `community` labels for public policy discussions - **Issues**: GitHub Issues with `conduct` or `community` labels for public policy discussions
- **Email**: maintainers@superclaude.org for general leadership questions - **Email**: anton.knoery@gmail.com for general leadership questions
**Leadership Responsibilities:** **Leadership Responsibilities:**
- **Policy Development**: Creating and updating community standards and enforcement procedures - **Policy Development**: Creating and updating community standards and enforcement procedures

24
CONTRIBUTING.md
View File

@ -12,7 +12,7 @@ SuperClaude Framework transforms Claude Code into a structured development platf
**Before Reporting:** **Before Reporting:**
- Search existing issues to avoid duplicates - Search existing issues to avoid duplicates
- Test with latest SuperClaude version - Test with latest SuperClaude version
- Verify issue isn't covered in [Troubleshooting Guide](Reference/troubleshooting.md) - Verify issue isn't covered in [Troubleshooting Guide](Docs/Reference/troubleshooting.md)
**Required Information:** **Required Information:**
- SuperClaude version: `SuperClaude --version` - SuperClaude version: `SuperClaude --version`
@ -188,8 +188,8 @@ Reference/ # Best practices and troubleshooting
- Security best practices for external integrations - Security best practices for external integrations
**Development Workflow:** **Development Workflow:**
1. Review [Technical Architecture](Developer-Guide/technical-architecture.md) 1. Review [Technical Architecture](Docs/Developer-Guide/technical-architecture.md)
2. Study [Contributing Code Guide](Developer-Guide/contributing-code.md) 2. Study [Contributing Code Guide](Docs/Developer-Guide/contributing-code.md)
3. Set up development environment 3. Set up development environment
4. Create feature branch from `master` 4. Create feature branch from `master`
5. Implement changes with tests 5. Implement changes with tests
@ -203,7 +203,7 @@ Reference/ # Best practices and troubleshooting
- Documentation completeness and clarity - Documentation completeness and clarity
- Test coverage and quality - Test coverage and quality
For detailed development guidelines, see [Contributing Code Guide](Developer-Guide/contributing-code.md). For detailed development guidelines, see [Contributing Code Guide](Docs/Developer-Guide/contributing-code.md).
## 🤝 Community Guidelines ## 🤝 Community Guidelines
@ -315,14 +315,14 @@ SuperClaude Framework enhances Claude Code for systematic software development w
- Design discussions for major features - Design discussions for major features
**Documentation Resources** **Documentation Resources**
- [Troubleshooting Guide](Reference/troubleshooting.md) - Common issues and solutions - [Troubleshooting Guide](Docs/Reference/troubleshooting.md) - Common issues and solutions
- [Examples Cookbook](Reference/examples-cookbook.md) - Practical usage patterns - [Examples Cookbook](Docs/Reference/examples-cookbook.md) - Practical usage patterns
- [Best Practices](Reference/best-practices.md) - Optimization strategies - [Quick Start Practices](Docs/Reference/quick-start-practices.md) - Optimization strategies
- [Technical Architecture](Developer-Guide/technical-architecture.md) - Framework design - [Technical Architecture](Docs/Developer-Guide/technical-architecture.md) - Framework design
**Development Support** **Development Support**
- [Contributing Code Guide](Developer-Guide/contributing-code.md) - Development setup - [Contributing Code Guide](Docs/Developer-Guide/contributing-code.md) - Development setup
- [Testing & Debugging](Developer-Guide/testing-debugging.md) - Quality procedures - [Testing & Debugging](Docs/Developer-Guide/testing-debugging.md) - Quality procedures
- Code review process through pull requests - Code review process through pull requests
- Maintainer guidance on complex contributions - Maintainer guidance on complex contributions
@ -344,7 +344,7 @@ Before seeking support, please:
**Development Environment Issues:** **Development Environment Issues:**
**Q: "SuperClaude install fails with permission errors"** **Q: "SuperClaude install fails with permission errors"**
A: Use `pip install --user SuperClaude` or create virtual environment. See [Installation Guide](Getting-Started/installation.md) for details. A: Use `pip install --user SuperClaude` or create virtual environment. See [Installation Guide](Docs/Getting-Started/installation.md) for details.
**Q: "Commands not recognized after installation"** **Q: "Commands not recognized after installation"**
A: Restart Claude Code session. Verify installation with `SuperClaude install --list-components`. Check ~/.claude directory exists. A: Restart Claude Code session. Verify installation with `SuperClaude install --list-components`. Check ~/.claude directory exists.
@ -358,7 +358,7 @@ A: Check Node.js installation for MCP servers. Verify ~/.claude/.claude.json con
A: Follow agent patterns in setup/components/agents.py. Include trigger keywords, capabilities description, and integration tests. A: Follow agent patterns in setup/components/agents.py. Include trigger keywords, capabilities description, and integration tests.
**Q: "Testing framework setup?"** **Q: "Testing framework setup?"**
A: See [Testing & Debugging Guide](Developer-Guide/testing-debugging.md). Use pytest for Python tests, include component validation. A: See [Testing & Debugging Guide](Docs/Developer-Guide/testing-debugging.md). Use pytest for Python tests, include component validation.
**Q: "Documentation structure?"** **Q: "Documentation structure?"**
A: Follow existing patterns: Getting-Started → User-Guide → Developer-Guide → Reference. Include examples and progressive complexity. A: Follow existing patterns: Getting-Started → User-Guide → Developer-Guide → Reference. Include examples and progressive complexity.

4
Docs/Developer-Guide/README.md
View File

@ -139,9 +139,7 @@ python -m SuperClaude --version
- **Feature Requests**: Propose enhancements through GitHub issues - **Feature Requests**: Propose enhancements through GitHub issues
### Community Resources ### Community Resources
- **GitHub Repository**: Main development and collaboration hub - **[GitHub Repository](https://github.com/SuperClaude-Org/SuperClaude_Framework)**: Main development and collaboration hub
- **Documentation**: Comprehensive guides and reference materials
- **Issue Tracker**: Bug reports and feature requests
## Contributing to Documentation ## Contributing to Documentation

17
Docs/Developer-Guide/contributing-code.md
View File

@ -597,18 +597,11 @@ Brief description of changes and motivation
- **Performance**: No significant performance degradation - **Performance**: No significant performance degradation
**Addressing Feedback:** **Addressing Feedback:**
```bash 1. Make requested changes to your code
# 1. Make requested changes 2. Commit with clear messages describing the fixes
# 2. Commit with clear messages 3. Push updates to your feature branch
git add . 4. Respond to review comments explaining your changes
git commit -m "address review: improve error handling in component loader" 5. Request re-review when ready
# 3. Push updates
git push origin feature/your-feature-name
# 4. Respond to review comments
# 5. Request re-review when ready
```
## 📋 Comprehensive Contributor Onboarding Checklist ## 📋 Comprehensive Contributor Onboarding Checklist

2
Docs/Developer-Guide/testing-debugging.md
View File

@ -4560,7 +4560,7 @@ if monitor.alerts:
**Core Documentation:** **Core Documentation:**
- [Technical Architecture](technical-architecture.md) - Framework design and patterns - [Technical Architecture](technical-architecture.md) - Framework design and patterns
- [Contributing Code](contributing-code.md) - Development setup and guidelines - [Contributing Code](contributing-code.md) - Development setup and guidelines
- [Best Practices](../Reference/best-practices.md) - Optimization and quality standards - [Best Practices](../Reference/quick-start-practices.md) - Optimization and quality standards
**Testing Resources:** **Testing Resources:**
- [Examples Cookbook](../Reference/examples-cookbook.md) - Practical testing examples - [Examples Cookbook](../Reference/examples-cookbook.md) - Practical testing examples

32
Docs/Getting-Started/installation.md
View File

@ -1,5 +1,7 @@
# SuperClaude Installation Guide 📦 # SuperClaude Installation Guide 📦
> **Command Context**: This guide uses **Terminal Commands** for installation and setup. These run in your terminal/command prompt, not inside Claude Code.
## 🎯 It's Easier Than It Looks! ## 🎯 It's Easier Than It Looks!
SuperClaude installs in under 2 minutes with an interactive installer. The process involves installing the Python package and running the component installer to configure your Claude Code environment. SuperClaude installs in under 2 minutes with an interactive installer. The process involves installing the Python package and running the component installer to configure your Claude Code environment.
@ -15,7 +17,7 @@ SuperClaude install
**Method 2: NPM (Cross-platform)** **Method 2: NPM (Cross-platform)**
```bash ```bash
npm install -g superclaude npm install -g superclaude
superclaude install SuperClaude install
``` ```
**Method 3: Development** **Method 3: Development**
@ -26,6 +28,17 @@ pip install -e ".[dev]"
SuperClaude install --dry-run SuperClaude install --dry-run
``` ```
### 📋 Command Quick Reference
| Command Type | Where to Run | Format | Example |
|-------------|--------------|--------|----------|
| **🖥️ Installation** | Terminal/CMD | `SuperClaude [command]` | `SuperClaude install` |
| **🔧 Configuration** | Terminal/CMD | `python3 -m SuperClaude` | `python3 -m SuperClaude --version` |
| **💬 Development** | Claude Code | `/sc:[command]` | `/sc:brainstorm "idea"` |
| **⚡ Workflow** | Claude Code | `/sc:[command] --flags` | `/sc:test --coverage` |
> **Important**: Installation commands run in your terminal. Once installed, you'll use `/sc:` commands inside Claude Code for development tasks.
--- ---
**What Gets Installed:** **What Gets Installed:**
@ -74,19 +87,6 @@ df -h ~
If any checks fail, see [Prerequisites Setup](#prerequisites-setup-🛠️) below. If any checks fail, see [Prerequisites Setup](#prerequisites-setup-🛠️) below.
```bash
# Check Python version (should be 3.8+)
python3 --version
# Check if Claude Code is available
claude --version
# Check Node.js (optional, for MCP servers)
node --version
```
If any of these fail, see the [Prerequisites Setup](#prerequisites-setup-🛠️) section below.
## Installation Options 🎛️ ## Installation Options 🎛️
### 🎯 Interactive Installation (Default - Recommended) ### 🎯 Interactive Installation (Default - Recommended)
@ -409,7 +409,7 @@ python scripts/validate_pypi_ready.py
**Essential Guides:** **Essential Guides:**
- 🚀 [Quick Start Guide](quick-start.md) - 5-minute setup - 🚀 [Quick Start Guide](quick-start.md) - 5-minute setup
- 🔧 [Commands Reference](../User-Guide/commands.md) - All 21 commands - 🔧 [Commands Reference](../User-Guide/commands.md) - All 21 commands
- 🧐 [Best Practices](../Reference/best-practices.md) - Optimization tips - 🧐 [Best Practices](../Reference/quick-start-practices.md) - Optimization tips
- 🎆 [Troubleshooting](../Reference/troubleshooting.md) - Problem solving - 🎆 [Troubleshooting](../Reference/troubleshooting.md) - Problem solving
--- ---
@ -443,4 +443,4 @@ python scripts/validate_pypi_ready.py
**Advanced** (🌲 Expert) **Advanced** (🌲 Expert)
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - System design - [Technical Architecture](../Developer-Guide/technical-architecture.md) - System design
- [Contributing Code](../Developer-Guide/contributing-code.md) - Development - [Contributing Code](../Developer-Guide/contributing-code.md) - Development
- [Best Practices](../Reference/best-practices.md) - Optimization strategies - [Best Practices](../Reference/quick-start-practices.md) - Optimization strategies

10
Docs/Getting-Started/quick-start.md
View File

@ -1,5 +1,7 @@
# SuperClaude Quick Start Guide # SuperClaude Quick Start Guide
> **Command Context**: This guide uses both **Terminal Commands** (for installation) and **Claude Code Commands** (`/sc:` for development). See sections below for where to run each type.
## The Simple Truth ## The Simple Truth
SuperClaude transforms Claude Code into a structured development framework with just one installation command. Behind the simple interface, intelligent routing automatically selects the right tools, activates domain experts, and coordinates complex workflows. SuperClaude transforms Claude Code into a structured development framework with just one installation command. Behind the simple interface, intelligent routing automatically selects the right tools, activates domain experts, and coordinates complex workflows.
@ -8,13 +10,13 @@ SuperClaude transforms Claude Code into a structured development framework with
## Just Start Here ## Just Start Here
**Installation (2 minutes):** ### 🖥️ Installation (2 minutes) - Run in Terminal
```bash ```bash
pip install SuperClaude && SuperClaude install pip install SuperClaude && SuperClaude install
``` ```
**First Commands (3 minutes):** ### 💬 First Commands (3 minutes) - Type in Claude Code
```bash ```
# Interactive project discovery # Interactive project discovery
/sc:brainstorm "web app for task management" /sc:brainstorm "web app for task management"
@ -164,7 +166,7 @@ SuperClaude transforms Claude Code from a general-purpose AI assistant into a **
**🌲 Advanced (Expert Usage)** **🌲 Advanced (Expert Usage)**
- [MCP Servers](../User-Guide/mcp-servers.md) - Enhanced capabilities - [MCP Servers](../User-Guide/mcp-servers.md) - Enhanced capabilities
- [Best Practices](../Reference/best-practices.md) - Optimization strategies - [Best Practices](../Reference/quick-start-practices.md) - Optimization strategies
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Deep understanding - [Technical Architecture](../Developer-Guide/technical-architecture.md) - Deep understanding
**🚑 Support** **🚑 Support**

4
Docs/Reference/common-issues.md
View File

@ -1,10 +1,12 @@
# Common Issues Guide # Common Issues Guide
> **Command Context**: This guide covers both **Terminal Commands** (for installation/setup issues) and **Claude Code Commands** (`/sc:` for development issues). Each section is clearly marked.
**Quick Resolution Focus**: Most common SuperClaude issues can be resolved in under 5 minutes with the right diagnostic approach. This guide provides systematic troubleshooting methods for installation, basic commands, and platform-specific problems. **Quick Resolution Focus**: Most common SuperClaude issues can be resolved in under 5 minutes with the right diagnostic approach. This guide provides systematic troubleshooting methods for installation, basic commands, and platform-specific problems.
**Problem Classification**: Issues are categorized by type for fast navigation - installation failures, command execution problems, and platform-specific compatibility issues. **Problem Classification**: Issues are categorized by type for fast navigation - installation failures, command execution problems, and platform-specific compatibility issues.
## Installation Issues ## 🖥️ Installation Issues (Terminal Commands)
### Permission and Access Problems ### Permission and Access Problems

2
Docs/Reference/examples-cookbook.md
View File

@ -154,7 +154,7 @@
- [Commands Reference](../User-Guide/commands.md) - Complete command documentation - [Commands Reference](../User-Guide/commands.md) - Complete command documentation
- [Agents Guide](../User-Guide/agents.md) - Multi-agent coordination - [Agents Guide](../User-Guide/agents.md) - Multi-agent coordination
- [MCP Servers](../User-Guide/mcp-servers.md) - Enhanced capabilities - [MCP Servers](../User-Guide/mcp-servers.md) - Enhanced capabilities
- [Best Practices](best-practices.md) - Optimization strategies - [Best Practices](quick-start-practices.md) - Optimization strategies
**Community**: **Community**:
- [GitHub Discussions](https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions) - Community support - [GitHub Discussions](https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions) - Community support

6
Docs/Reference/troubleshooting.md
View File

@ -1,5 +1,7 @@
# SuperClaude Troubleshooting Guide # SuperClaude Troubleshooting Guide
> **Command Context**: This guide covers both **Terminal Commands** (for installation issues) and **Claude Code Commands** (`/sc:` for development issues). Look for section headers to know which type to use.
**Comprehensive Problem Resolution**: Step-by-step solutions for common SuperClaude issues, from installation problems to advanced configuration challenges. Each solution includes diagnosis steps, resolution procedures, and prevention strategies. **Comprehensive Problem Resolution**: Step-by-step solutions for common SuperClaude issues, from installation problems to advanced configuration challenges. Each solution includes diagnosis steps, resolution procedures, and prevention strategies.
**Quick Resolution Focus**: Most issues can be resolved in under 5 minutes with the right diagnostic approach. This guide provides systematic troubleshooting methods to get you back to productive development quickly. **Quick Resolution Focus**: Most issues can be resolved in under 5 minutes with the right diagnostic approach. This guide provides systematic troubleshooting methods to get you back to productive development quickly.
@ -1212,7 +1214,7 @@ time /sc:analyze . --scope module # Module-scoped analysis
**Advanced Topics:** **Advanced Topics:**
- [Examples Cookbook](examples-cookbook.md) - Working examples and practical troubleshooting scenarios - [Examples Cookbook](examples-cookbook.md) - Working examples and practical troubleshooting scenarios
- [Best Practices](best-practices.md) - Performance optimization and efficiency troubleshooting - [Best Practices](quick-start-practices.md) - Performance optimization and efficiency troubleshooting
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Deep system understanding for complex issues - [Technical Architecture](../Developer-Guide/technical-architecture.md) - Deep system understanding for complex issues
### Developer Resources ### Developer Resources
@ -1231,7 +1233,7 @@ time /sc:analyze . --scope module # Module-scoped analysis
**Immediate Help:** **Immediate Help:**
- Installation Issues → [Installation Guide](../Getting-Started/installation.md) - Installation Issues → [Installation Guide](../Getting-Started/installation.md)
- Command Problems → [Commands Reference](../User-Guide/commands.md) - Command Problems → [Commands Reference](../User-Guide/commands.md)
- Performance Issues → [Best Practices](best-practices.md) - Performance Issues → [Best Practices](quick-start-practices.md)
- Configuration Issues → [MCP Servers](../User-Guide/mcp-servers.md) - Configuration Issues → [MCP Servers](../User-Guide/mcp-servers.md)
**Learning Resources:** **Learning Resources:**

2
Docs/User-Guide/agents.md
View File

@ -765,7 +765,7 @@ Add "documented", "explained", or "tutorial" to requests for automatic technical
### Advanced Usage ### Advanced Usage
- **[Behavioral Modes](modes.md)** - Context optimization for enhanced agent coordination - **[Behavioral Modes](modes.md)** - Context optimization for enhanced agent coordination
- **[Best Practices](../Reference/best-practices.md)** - Expert techniques for agent optimization - **[Best Practices](../Reference/quick-start-practices.md)** - Expert techniques for agent optimization
- **[Examples Cookbook](../Reference/examples-cookbook.md)** - Real-world agent coordination patterns - **[Examples Cookbook](../Reference/examples-cookbook.md)** - Real-world agent coordination patterns
### Development Resources ### Development Resources

33
Docs/User-Guide/commands.md
View File

@ -1,5 +1,7 @@
# SuperClaude Commands Guide # SuperClaude Commands Guide
> **Command Context**: This guide covers **Claude Code Commands** (`/sc:` commands). These run inside Claude Code chat, not in your terminal. For installation commands, see [Installation Guide](../Getting-Started/installation.md).
## ✅ Verification Status ## ✅ Verification Status
- **SuperClaude Version**: v4.0+ Compatible - **SuperClaude Version**: v4.0+ Compatible
- **Last Tested**: 2025-01-16 - **Last Tested**: 2025-01-16
@ -10,24 +12,41 @@
## 🧪 Testing Your Setup ## 🧪 Testing Your Setup
Before using this guide, verify your SuperClaude installation: ### 🖥️ Terminal Verification (Run in Terminal/CMD)
```bash ```bash
# Verify SuperClaude is working # Verify SuperClaude is working
SuperClaude --version SuperClaude --version
# Expected: SuperClaude Framework v4.0+ # Expected: SuperClaude Framework v4.0+
# Test basic command syntax
echo "/sc:brainstorm 'test'" | claude --help
# Expected: No syntax errors
# Check MCP server connectivity # Check MCP server connectivity
SuperClaude status --mcp SuperClaude status --mcp
# Expected: At least context7 and sequential-thinking connected # Expected: At least context7 and sequential-thinking connected
``` ```
### 💬 Claude Code Testing (Type in Claude Code Chat)
```
# Test basic /sc: command
/sc:brainstorm "test project"
# Expected: Interactive requirements discovery starts
# Test command help
/sc:help
# Expected: List of available commands
```
**If tests fail**: Check [Installation Guide](../Getting-Started/installation.md) or [Troubleshooting](#troubleshooting) **If tests fail**: Check [Installation Guide](../Getting-Started/installation.md) or [Troubleshooting](#troubleshooting)
### 📋 Command Quick Reference
| Command Type | Where to Run | Format | Purpose |
|-------------|--------------|--------|---------|
| **🖥️ Installation** | Terminal/CMD | `SuperClaude [command]` | Setup and maintenance |
| **🔧 Configuration** | Terminal/CMD | `python3 -m SuperClaude` | Advanced configuration |
| **💬 Development** | Claude Code | `/sc:[command]` | AI-enhanced development |
| **⚡ Workflow** | Claude Code | `/sc:[command] --flags` | Enhanced automation |
> **Remember**: All `/sc:` commands work inside Claude Code chat, not your terminal.
## Table of Contents ## Table of Contents
- [Essential Commands](#essential-commands) - Start here (8 core commands) - [Essential Commands](#essential-commands) - Start here (8 core commands)
@ -660,7 +679,7 @@ SuperClaude install --components mcp --force
**Documentation** **Documentation**
- [Quick Start Guide](../Getting-Started/quick-start.md) - Essential setup and first steps - [Quick Start Guide](../Getting-Started/quick-start.md) - Essential setup and first steps
- [Best Practices](../Reference/best-practices.md) - Optimization and workflow patterns - [Best Practices](../Reference/quick-start-practices.md) - Optimization and workflow patterns
- [Examples Cookbook](../Reference/examples-cookbook.md) - Real-world usage patterns - [Examples Cookbook](../Reference/examples-cookbook.md) - Real-world usage patterns
**Community Support** **Community Support**

2
Docs/User-Guide/flags.md
View File

@ -940,7 +940,7 @@ SuperClaude validate-flags --think-hard --no-mcp --magic
**🌲 Advanced (Month 2+)** **🌲 Advanced (Month 2+)**
- [Session Management](session-management.md) - Long-term flag patterns - [Session Management](session-management.md) - Long-term flag patterns
- [Best Practices](../Reference/best-practices.md) - Flag optimization strategies - [Best Practices](../Reference/quick-start-practices.md) - Flag optimization strategies
- [Examples Cookbook](../Reference/examples-cookbook.md) - Real-world flag combinations - [Examples Cookbook](../Reference/examples-cookbook.md) - Real-world flag combinations
**🔧 Expert** **🔧 Expert**

2
Docs/User-Guide/mcp-servers.md
View File

@ -1212,7 +1212,7 @@ Learning new technology?
**🌲 Advanced (Month 2+)** **🌲 Advanced (Month 2+)**
- [Session Management](session-management.md) - Serena MCP workflows - [Session Management](session-management.md) - Serena MCP workflows
- [Best Practices](../Reference/best-practices.md) - MCP optimization strategies - [Best Practices](../Reference/quick-start-practices.md) - MCP optimization strategies
- [Flags Guide](flags.md) - Advanced MCP control - [Flags Guide](flags.md) - Advanced MCP control
**🔧 Expert** **🔧 Expert**

4
Docs/User-Guide/modes.md
View File

@ -610,7 +610,7 @@ SuperClaude's 6 behavioral modes create an **intelligent adaptation system** tha
**🌲 Advanced (Month 2+)** **🌲 Advanced (Month 2+)**
- [MCP Servers](mcp-servers.md) - Mode integration with enhanced capabilities - [MCP Servers](mcp-servers.md) - Mode integration with enhanced capabilities
- [Session Management](session-management.md) - Task Management mode workflows - [Session Management](session-management.md) - Task Management mode workflows
- [Best Practices](../Reference/best-practices.md) - Mode optimization strategies - [Best Practices](../Reference/quick-start-practices.md) - Mode optimization strategies
**🔧 Expert** **🔧 Expert**
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Mode implementation details - [Technical Architecture](../Developer-Guide/technical-architecture.md) - Mode implementation details
@ -620,4 +620,4 @@ SuperClaude's 6 behavioral modes create an **intelligent adaptation system** tha
- **Brainstorming**: [Requirements Discovery Patterns](../Reference/examples-cookbook.md#requirements) - **Brainstorming**: [Requirements Discovery Patterns](../Reference/examples-cookbook.md#requirements)
- **Task Management**: [Session Management Guide](session-management.md) - **Task Management**: [Session Management Guide](session-management.md)
- **Orchestration**: [MCP Servers Guide](mcp-servers.md) - **Orchestration**: [MCP Servers Guide](mcp-servers.md)
- **Token Efficiency**: [Performance Optimization](../Reference/best-practices.md#efficiency) - **Token Efficiency**: [Performance Optimization](../Reference/quick-start-practices.md#efficiency)

2
Docs/User-Guide/session-management.md
View File

@ -1262,7 +1262,7 @@ As you work with SuperClaude, it automatically learns:
- [Flags Guide](flags.md) - Session optimization flags - [Flags Guide](flags.md) - Session optimization flags
**Advanced Resources:** **Advanced Resources:**
- [Best Practices](../Reference/best-practices.md) - Session optimization strategies - [Best Practices](../Reference/quick-start-practices.md) - Session optimization strategies
- [Examples Cookbook](../Reference/examples-cookbook.md) - Complex workflow patterns - [Examples Cookbook](../Reference/examples-cookbook.md) - Complex workflow patterns
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Implementation details - [Technical Architecture](../Developer-Guide/technical-architecture.md) - Implementation details

6
PUBLISHING.md
View File

@ -886,7 +886,7 @@ gh release create v4.0.1 \
**Primary Maintainers:** **Primary Maintainers:**
- **GitHub**: @SuperClaude-Org maintainer team - **GitHub**: @SuperClaude-Org maintainer team
- **Issues**: https://github.com/SuperClaude-Org/SuperClaude_Framework/issues - **Issues**: https://github.com/SuperClaude-Org/SuperClaude_Framework/issues
- **Email**: maintainers@superclaude.org (for urgent publishing issues) - **Email**: anton.knoery@gmail.com (for urgent publishing issues)
**Specific Support Areas:** **Specific Support Areas:**
@ -912,13 +912,13 @@ gh release create v4.0.1 \
**Emergency Contacts:** **Emergency Contacts:**
For critical security patches or urgent publishing needs: For critical security patches or urgent publishing needs:
- **Security**: security@superclaude.org - **Security**: anton.knoery@gmail.com
- **Direct**: Maintainer contact information provided upon first contact - **Direct**: Maintainer contact information provided upon first contact
- **Priority**: Use `urgent` label on GitHub issues for expedited response - **Priority**: Use `urgent` label on GitHub issues for expedited response
**Self-Service Resources:** **Self-Service Resources:**
Before contacting support: Before contacting support:
1. Review this publishing guide thoroughly 1. Review this publishing guide thoroughly
2. Check [Troubleshooting](Reference/troubleshooting.md) documentation 2. Check [Troubleshooting](Docs/Reference/troubleshooting.md) documentation
3. Search existing GitHub issues for similar problems 3. Search existing GitHub issues for similar problems
4. Test with latest versions and clean environments 4. Test with latest versions and clean environments

28
README.md
View File

@ -29,26 +29,26 @@ SuperClaude Framework development requires ongoing support to maintain MCP serve
## Documentation ## Documentation
### Getting Started ### Getting Started
- [Quick Start Guide](Getting-Started/quick-start.md) - [Quick Start Guide](Docs/Getting-Started/quick-start.md)
- [Installation Guide](Getting-Started/installation.md) - [Installation Guide](Docs/Getting-Started/installation.md)
### User Guides ### User Guides
- [Commands Reference](User-Guide/commands.md) - [Commands Reference](Docs/User-Guide/commands.md)
- [Agents Guide](User-Guide/agents.md) - [Agents Guide](Docs/User-Guide/agents.md)
- [Behavioral Modes](User-Guide/modes.md) - [Behavioral Modes](Docs/User-Guide/modes.md)
- [Flags Guide](User-Guide/flags.md) - [Flags Guide](Docs/User-Guide/flags.md)
- [MCP Servers](User-Guide/mcp-servers.md) - [MCP Servers](Docs/User-Guide/mcp-servers.md)
- [Session Management](User-Guide/session-management.md) - [Session Management](Docs/User-Guide/session-management.md)
### Developer Resources ### Developer Resources
- [Technical Architecture](Developer-Guide/technical-architecture.md) - [Technical Architecture](Docs/Developer-Guide/technical-architecture.md)
- [Contributing Code](Developer-Guide/contributing-code.md) - [Contributing Code](Docs/Developer-Guide/contributing-code.md)
- [Testing & Debugging](Developer-Guide/testing-debugging.md) - [Testing & Debugging](Docs/Developer-Guide/testing-debugging.md)
### Reference ### Reference
- [Best Practices](Reference/best-practices.md) - [Quick Start Practices](Docs/Reference/quick-start-practices.md)
- [Examples Cookbook](Reference/examples-cookbook.md) - [Examples Cookbook](Docs/Reference/examples-cookbook.md)
- [Troubleshooting](Reference/troubleshooting.md) - [Troubleshooting](Docs/Reference/troubleshooting.md)
## Contributing ## Contributing

29
SECURITY.md
View File

@ -12,10 +12,10 @@ SuperClaude Framework prioritizes security through secure-by-design principles,
### Responsible Disclosure ### Responsible Disclosure
**Primary Contact:** security@superclaude.org (monitored by maintainers) **Primary Contact:** anton.knoery@gmail.com (monitored by maintainers)
**Process:** **Process:**
1. **Report**: Send detailed vulnerability report to security@superclaude.org 1. **Report**: Send detailed vulnerability report to anton.knoery@gmail.com
2. **Acknowledgment**: We'll confirm receipt within 48 hours 2. **Acknowledgment**: We'll confirm receipt within 48 hours
3. **Investigation**: Initial assessment within 72 hours 3. **Investigation**: Initial assessment within 72 hours
4. **Coordination**: Work together on fix development and testing 4. **Coordination**: Work together on fix development and testing
@ -599,7 +599,7 @@ As the project grows and secures funding:
### Security Team ### Security Team
**Primary Security Contact:** **Primary Security Contact:**
- **Email**: security@superclaude.org - **Email**: anton.knoery@gmail.com
- **Monitored By**: Core maintainers and security-focused contributors - **Monitored By**: Core maintainers and security-focused contributors
- **Response Time**: 48-72 hours for initial acknowledgment - **Response Time**: 48-72 hours for initial acknowledgment
- **Escalation**: Direct maintainer contact for critical issues requiring immediate attention - **Escalation**: Direct maintainer contact for critical issues requiring immediate attention
@ -618,21 +618,20 @@ As the project grows and secures funding:
**Encrypted Communication:** **Encrypted Communication:**
For sensitive security discussions requiring encrypted communication: For sensitive security discussions requiring encrypted communication:
- **GPG Key**: Available upon request to security@superclaude.org - **GPG Key**: Available upon request to anton.knoery@gmail.com
- **Signal**: Secure messaging coordination available for complex cases - **Signal**: Secure messaging coordination available for complex cases
- **Private Channels**: Dedicated security discussion channels for verified researchers - **Private Channels**: Dedicated security discussion channels for verified researchers
**Emergency Contact:** **Emergency Contact:**
For critical vulnerabilities requiring immediate attention: For critical vulnerabilities requiring immediate attention:
- **GitHub**: Direct message to @SuperClaude-Security team - **Priority Email**: anton.knoery@gmail.com (monitored continuously)
- **Priority Email**: security-urgent@superclaude.org (monitored continuously)
- **Escalation Path**: Direct maintainer contact information provided upon first contact - **Escalation Path**: Direct maintainer contact information provided upon first contact
### General Security Questions ### General Security Questions
**General Security Questions:** **General Security Questions:**
- **GitHub Discussions**: https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions - **GitHub Discussions**: https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions
- **Community Forums**: Security-focused discussion threads - **Community Forums**: Security-focused discussion threads
- **Documentation**: [Security Best Practices](Reference/best-practices.md#security-practices) - **Documentation**: [Security Best Practices](Docs/Reference/quick-start-practices.md#security-practices)
- **Issue Tracker**: Non-sensitive security configuration questions - **Issue Tracker**: Non-sensitive security configuration questions
**Technical Security Support:** **Technical Security Support:**
@ -664,25 +663,25 @@ For organizations requiring dedicated security support:
### Security-Related Documentation ### Security-Related Documentation
**Framework Security Documentation:** **Framework Security Documentation:**
- [Best Practices Guide](Reference/best-practices.md) - Security-focused usage patterns - [Quick Start Practices Guide](Docs/Reference/quick-start-practices.md) - Security-focused usage patterns
- [Technical Architecture](Developer-Guide/technical-architecture.md) - Security design principles - [Technical Architecture](Docs/Developer-Guide/technical-architecture.md) - Security design principles
- [Contributing Code Guide](Developer-Guide/contributing-code.md) - Secure development practices - [Contributing Code Guide](Docs/Developer-Guide/contributing-code.md) - Secure development practices
- [Testing & Debugging Guide](Developer-Guide/testing-debugging.md) - Security testing procedures - [Testing & Debugging Guide](Docs/Developer-Guide/testing-debugging.md) - Security testing procedures
**MCP Server Security:** **MCP Server Security:**
- [MCP Servers Guide](User-Guide/mcp-servers.md) - Server security configuration - [MCP Servers Guide](Docs/User-Guide/mcp-servers.md) - Server security configuration
- [Troubleshooting Guide](Reference/troubleshooting.md) - Security-related issue resolution - [Troubleshooting Guide](Docs/Reference/troubleshooting.md) - Security-related issue resolution
- MCP Server Documentation - Individual server security considerations - MCP Server Documentation - Individual server security considerations
- Configuration Security - Secure MCP setup and credential management - Configuration Security - Secure MCP setup and credential management
**Agent Security:** **Agent Security:**
- [Agents Guide](User-Guide/agents.md) - Agent security boundaries and coordination - [Agents Guide](Docs/User-Guide/agents.md) - Agent security boundaries and coordination
- Agent Development - Security considerations for agent implementation - Agent Development - Security considerations for agent implementation
- Behavioral Modes - Security implications of different operational modes - Behavioral Modes - Security implications of different operational modes
- Command Security - Security aspects of command execution and validation - Command Security - Security aspects of command execution and validation
**Session Management Security:** **Session Management Security:**
- [Session Management Guide](User-Guide/session-management.md) - Secure session handling - [Session Management Guide](Docs/User-Guide/session-management.md) - Secure session handling
- Memory Security - Secure handling of persistent session data - Memory Security - Secure handling of persistent session data
- Project Isolation - Security boundaries between different projects - Project Isolation - Security boundaries between different projects
- Context Security - Secure context loading and validation - Context Security - Secure context loading and validation

170
TODO.md
View File

@ -1,2 +1,172 @@
agents.md : agents.md :
Missing @agent mention tutorial Missing @agent mention tutorial
Executive Summary
After a deep analysis of the entire Docs/ directory, I've identified
several categories of issues requiring attention. The documentation is
generally well-structured but contains inconsistencies, command syntax
variations, and some content issues.
---
1. Command Syntax Inconsistencies
Issue: Mixed usage of "SuperClaude install" vs "superclaude install"
- Files Affected: installation.md, multiple reference files
- Pattern: Inconsistent capitalization of the command
- Line 12: SuperClaude install
- Line 18: superclaude install (lowercase)
- Throughout: Mixed usage creates confusion
Issue: Inconsistent /sc: command prefix
- Files Affected: commands.md, quick-start-practices.md, modes.md
- Pattern: Some examples use /sc:help while documentation references /sc:
prefix
- No clear explanation when to use which format
---
2. Content Duplications
Already Fixed Issues:
- ✅ Developer-Guide/README.md - Line 141-144 duplication (FIXED)
- ✅ Developer-Guide/contributing-code.md - Lines 599-611 duplication
(FIXED)
- ✅ Getting-Started/installation.md - Lines 77-88 duplication (FIXED)
Remaining Duplications:
- Reference/troubleshooting.md & common-issues.md: Significant overlap in
installation troubleshooting content
- Both files contain nearly identical permission error solutions
- Component installation failure solutions repeated
---
3. Invalid or Placeholder Content
Issue: Placeholder issue numbers
- Developer-Guide/contributing-code.md Line 599: Contains Closes #XXX
placeholder
- Should be replaced with actual issue number format or example
Issue: Debug environment variables
- Multiple files: References to SUPERCLAUDE_DEBUG environment variables
- No clear documentation on whether these are actual environment
variables or examples
- Inconsistent formatting between files
---
4. Email Address Issues (Already Fixed)
✅ All invalid @superclaude.org emails replaced with
anton.knoery@gmail.com
✅ Non-existent @SuperClaude-Security team reference removed
---
5. Cross-Reference Issues
Issue: Some references still missing Docs/ prefix
- Most have been fixed, but some internal references within Docs/
subdirectories may still be incorrect
- Relative path references (../) are correct but could be more robust
---
6. Formatting Inconsistencies
Issue: Inconsistent heading levels
- Some files use ### for main sections, others use ##
- Agent documentation uses #### for individual agents inconsistently
Issue: Code block language tags
- Some use bash, others use cmd or no language tag
- Python code blocks sometimes missing language identifier
---
7. Missing or Incomplete Content
Issue: TODO markers found
- contributing-code.md Line 1999: Reference to "Find documentation TODOs"
- Suggests incomplete documentation sections exist
Issue: Incomplete error codes
- commands.md: Error codes E001-E008 defined but not all are referenced
in troubleshooting
- Missing error codes E009+ that might be in use
---
8. Version and Component References
Issue: No clear version consistency
- Documentation doesn't consistently reference SuperClaude version 4.0.0
- Some examples may be from older versions
Issue: Component installation order
- Multiple different recommendations for installation order:
- Some say: core → agents → modes → mcp
- Others say: core → mcp → modes → agents
- Need standardization
---
9. Platform-Specific Issues
Issue: Windows path examples
- Some Windows examples use forward slashes instead of backslashes
- Inconsistent use of %USERPROFILE% vs explicit paths
Issue: Mixed shell syntax
- Some examples mix bash and Windows cmd syntax
- PowerShell examples not clearly marked
---
10. Accessibility and Navigation
Positive: Good accessibility features present
- Screen reader support mentioned
- WCAG 2.1 compliance claimed
- Alternative text for diagrams mentioned
Issue: Navigation depth
- Some documents exceed 4000 lines (testing-debugging.md,
technical-architecture.md)
- Could benefit from splitting into smaller, focused documents
---
Summary Statistics
- Total Files Analyzed: 24 markdown files
- Total Issues Found: ~35 distinct issues
- Critical Issues: 0 (no security or breaking issues)
- High Priority: 5 (command inconsistencies, duplications)
- Medium Priority: 15 (formatting, references)
- Low Priority: 15 (style, optimization)
Recommendations
1. Standardize command syntax throughout all documentation
2. Consolidate duplicate content between troubleshooting and
common-issues
3. Fix placeholder content like #XXX
4. Establish consistent formatting guidelines
5. Create a documentation style guide for contributors
6. Split large documents for better navigation
7. Add version tags to all examples
8. Clarify component installation order
---
Note: This report provides findings only. No corrections have been made
as requested.