External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-29 16:16:08 +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
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -139,9 +139,7 @@ python -m SuperClaude --version
- **Feature Requests**: Propose enhancements through GitHub issues
### Community Resources
- **GitHub Repository**: Main development and collaboration hub
- **Documentation**: Comprehensive guides and reference materials
- **Issue Tracker**: Bug reports and feature requests
- **[GitHub Repository](https://github.com/SuperClaude-Org/SuperClaude_Framework)**: Main development and collaboration hub
## 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
**Addressing Feedback:**
```bash
# 1. Make requested changes
# 2. Commit with clear messages
git add .
git commit -m "address review: improve error handling in component loader"
# 3. Push updates
git push origin feature/your-feature-name
# 4. Respond to review comments
# 5. Request re-review when ready
```
1. Make requested changes to your code
2. Commit with clear messages describing the fixes
3. Push updates to your feature branch
4. Respond to review comments explaining your changes
5. Request re-review when ready
## 📋 Comprehensive Contributor Onboarding Checklist

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

@@ -4560,7 +4560,7 @@ if monitor.alerts:
**Core Documentation:**
- [Technical Architecture](technical-architecture.md) - Framework design and patterns
- [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:**
- [Examples Cookbook](../Reference/examples-cookbook.md) - Practical testing examples

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

@@ -1,5 +1,7 @@
# 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!
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)**
```bash
npm install -g superclaude
superclaude install
SuperClaude install
```
**Method 3: Development**
@@ -26,6 +28,17 @@ pip install -e ".[dev]"
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:**
@@ -74,19 +87,6 @@ df -h ~
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 🎛️
### 🎯 Interactive Installation (Default - Recommended)
@@ -409,7 +409,7 @@ python scripts/validate_pypi_ready.py
**Essential Guides:**
- 🚀 [Quick Start Guide](quick-start.md) - 5-minute setup
- 🔧 [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
---
@@ -443,4 +443,4 @@ python scripts/validate_pypi_ready.py
**Advanced** (🌲 Expert)
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - System design
- [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
> **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
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
**Installation (2 minutes):**
### 🖥️ Installation (2 minutes) - Run in Terminal
```bash
pip install SuperClaude && SuperClaude install
```
**First Commands (3 minutes):**
```bash
### 💬 First Commands (3 minutes) - Type in Claude Code
```
# Interactive project discovery
/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)**
- [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
**🚑 Support**

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

@@ -1,10 +1,12 @@
# 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.
**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

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

@@ -154,7 +154,7 @@
- [Commands Reference](../User-Guide/commands.md) - Complete command documentation
- [Agents Guide](../User-Guide/agents.md) - Multi-agent coordination
- [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**:
- [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
> **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.
**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:**
- [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
### Developer Resources
@@ -1231,7 +1233,7 @@ time /sc:analyze . --scope module # Module-scoped analysis
**Immediate Help:**
- Installation Issues → [Installation Guide](../Getting-Started/installation.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)
**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
- **[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
### Development Resources

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

@@ -1,5 +1,7 @@
# 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
- **SuperClaude Version**: v4.0+ Compatible
- **Last Tested**: 2025-01-16
@@ -10,24 +12,41 @@
## 🧪 Testing Your Setup
Before using this guide, verify your SuperClaude installation:
### 🖥️ Terminal Verification (Run in Terminal/CMD)
```bash
# Verify SuperClaude is working
SuperClaude --version
# Expected: SuperClaude Framework v4.0+
# Test basic command syntax
echo "/sc:brainstorm 'test'" | claude --help
# Expected: No syntax errors
# Check MCP server connectivity
SuperClaude status --mcp
# 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)
### 📋 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
- [Essential Commands](#essential-commands) - Start here (8 core commands)
@@ -660,7 +679,7 @@ SuperClaude install --components mcp --force
**Documentation**
- [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
**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+)**
- [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
**🔧 Expert**

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

@@ -1212,7 +1212,7 @@ Learning new technology?
**🌲 Advanced (Month 2+)**
- [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
**🔧 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+)**
- [MCP Servers](mcp-servers.md) - Mode integration with enhanced capabilities
- [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**
- [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)
- **Task Management**: [Session Management Guide](session-management.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
**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
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Implementation details