mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
🔧 Fix command syntax inconsistencies and improve documentation clarity
## 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:
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:**
|
||||
|
||||
Reference in New Issue
Block a user