From 0e856a997538a7115fb4d7860043d9f62769f037 Mon Sep 17 00:00:00 2001 From: NomenAK Date: Mon, 18 Aug 2025 13:01:14 +0200 Subject: [PATCH] Standardize internal markdown references with explicit relative paths MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit • Updated troubleshooting.md, optimization-guide.md, mcp-server-guide.md, diagnostic-reference.md, and README.md • Changed internal references from (filename.md) to (./filename.md) format • Improved link robustness and portability across different viewing contexts • Completed cross-reference standardization throughout Reference directory 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- Docs/Reference/README.md | 66 ++++++++++++------------- Docs/Reference/advanced-patterns.md | 8 +-- Docs/Reference/diagnostic-reference.md | 4 +- Docs/Reference/examples-cookbook.md | 62 +++++++++++------------ Docs/Reference/mcp-server-guide.md | 4 +- Docs/Reference/optimization-guide.md | 6 +-- Docs/Reference/quick-start-practices.md | 14 +++--- Docs/Reference/troubleshooting.md | 22 ++++----- 8 files changed, 93 insertions(+), 93 deletions(-) diff --git a/Docs/Reference/README.md b/Docs/Reference/README.md index 983579f..c91587a 100644 --- a/Docs/Reference/README.md +++ b/Docs/Reference/README.md @@ -21,17 +21,17 @@ This documentation is organized for **progressive learning** with multiple entry | Document | Purpose | Target Audience | Complexity | Time Investment | |----------|---------|-----------------|------------|-----------------| -| **[quick-start-practices.md](quick-start-practices.md)** | Essential foundations and first steps | New users, onboarding | **Basic** | 30-60 minutes | -| **[basic-examples.md](basic-examples.md)** | Copy-paste ready commands and patterns | All users, quick reference | **Basic** | 15-30 minutes | -| **[examples-cookbook.md](examples-cookbook.md)** | Recipe collection hub and organization | All users, navigation | **Reference** | 5 minutes | -| **[common-issues.md](common-issues.md)** | Essential troubleshooting and solutions | All users, problem-solving | **Basic** | As needed | -| **[mcp-server-guide.md](mcp-server-guide.md)** | MCP server configuration and usage | Technical users, integration | **Intermediate** | 45-90 minutes | -| **[optimization-guide.md](optimization-guide.md)** | Performance tuning and efficiency | All levels, improvement | **Variable** | 60-120 minutes | -| **[advanced-patterns.md](advanced-patterns.md)** | Expert coordination and orchestration | Experienced users | **Advanced** | 90-150 minutes | -| **[advanced-workflows.md](advanced-workflows.md)** | Complex multi-agent orchestration | Expert users | **Advanced** | 120-180 minutes | -| **[integration-patterns.md](integration-patterns.md)** | Framework and system integration | Architects, experts | **Advanced** | 90-150 minutes | -| **[troubleshooting.md](troubleshooting.md)** | Comprehensive diagnostic guide | All levels, deep debugging | **Variable** | As needed | -| **[diagnostic-reference.md](diagnostic-reference.md)** | Advanced debugging and analysis | Expert users, complex issues | **Advanced** | 60-120 minutes | +| **[quick-start-practices.md](./quick-start-practices.md)** | Essential foundations and first steps | New users, onboarding | **Basic** | 30-60 minutes | +| **[basic-examples.md](./basic-examples.md)** | Copy-paste ready commands and patterns | All users, quick reference | **Basic** | 15-30 minutes | +| **[examples-cookbook.md](./examples-cookbook.md)** | Recipe collection hub and organization | All users, navigation | **Reference** | 5 minutes | +| **[common-issues.md](./common-issues.md)** | Essential troubleshooting and solutions | All users, problem-solving | **Basic** | As needed | +| **[mcp-server-guide.md](./mcp-server-guide.md)** | MCP server configuration and usage | Technical users, integration | **Intermediate** | 45-90 minutes | +| **[optimization-guide.md](./optimization-guide.md)** | Performance tuning and efficiency | All levels, improvement | **Variable** | 60-120 minutes | +| **[advanced-patterns.md](./advanced-patterns.md)** | Expert coordination and orchestration | Experienced users | **Advanced** | 90-150 minutes | +| **[advanced-workflows.md](./advanced-workflows.md)** | Complex multi-agent orchestration | Expert users | **Advanced** | 120-180 minutes | +| **[integration-patterns.md](./integration-patterns.md)** | Framework and system integration | Architects, experts | **Advanced** | 90-150 minutes | +| **[troubleshooting.md](./troubleshooting.md)** | Comprehensive diagnostic guide | All levels, deep debugging | **Variable** | As needed | +| **[diagnostic-reference.md](./diagnostic-reference.md)** | Advanced debugging and analysis | Expert users, complex issues | **Advanced** | 60-120 minutes | --- @@ -159,19 +159,19 @@ Advanced Analysis: diagnostic-reference.md ## Problem-Solving Quick Reference ### Immediate Issues (< 5 minutes) -- **Command not working**: Check [common-issues.md](common-issues.md) → Common SuperClaude Problems -- **Session lost**: Use `/sc:load` → See [quick-start-practices.md](quick-start-practices.md) → Session Management -- **Flag confusion**: Check [basic-examples.md](basic-examples.md) → Flag Usage Examples +- **Command not working**: Check [common-issues.md](./common-issues.md) → Common SuperClaude Problems +- **Session lost**: Use `/sc:load` → See [quick-start-practices.md](./quick-start-practices.md) → Session Management +- **Flag confusion**: Check [basic-examples.md](./basic-examples.md) → Flag Usage Examples ### Development Blockers (15-30 minutes) -- **Performance slow**: See [optimization-guide.md](optimization-guide.md) → Performance Patterns -- **Complex debugging**: Use [troubleshooting.md](troubleshooting.md) → Systematic Debugging -- **Integration issues**: Check [integration-patterns.md](integration-patterns.md) → Framework Patterns +- **Performance slow**: See [optimization-guide.md](./optimization-guide.md) → Performance Patterns +- **Complex debugging**: Use [troubleshooting.md](./troubleshooting.md) → Systematic Debugging +- **Integration issues**: Check [integration-patterns.md](./integration-patterns.md) → Framework Patterns ### System-Level Issues (45+ minutes) -- **Architecture problems**: Use [advanced-workflows.md](advanced-workflows.md) → System Design -- **Expert debugging**: Apply [diagnostic-reference.md](diagnostic-reference.md) → Advanced Analysis -- **Custom workflow needs**: Study [advanced-patterns.md](advanced-patterns.md) → Custom Orchestration +- **Architecture problems**: Use [advanced-workflows.md](./advanced-workflows.md) → System Design +- **Expert debugging**: Apply [diagnostic-reference.md](./diagnostic-reference.md) → Advanced Analysis +- **Custom workflow needs**: Study [advanced-patterns.md](./advanced-patterns.md) → Custom Orchestration --- @@ -192,7 +192,7 @@ Advanced Analysis: diagnostic-reference.md ### Reporting Issues Found outdated information or broken examples? -1. **Quick Fixes**: Check [common-issues.md](common-issues.md) first +1. **Quick Fixes**: Check [common-issues.md](./common-issues.md) first 2. **Documentation Bugs**: Report via project issues with specific file and line 3. **Missing Patterns**: Suggest additions with use case description 4. **Verification Requests**: Request re-testing of specific examples @@ -214,7 +214,7 @@ Found outdated information or broken examples? 4. **Community Learning**: Share discoveries and learn from others' approaches ### Troubleshooting Mastery -1. **Systematic Approach**: Always start with [common-issues.md](common-issues.md) +1. **Systematic Approach**: Always start with [common-issues.md](./common-issues.md) 2. **Evidence Gathering**: Use `--think` for complex problem analysis 3. **Root Cause Focus**: Address underlying issues, not just symptoms 4. **Documentation First**: Check official docs before experimental solutions @@ -224,16 +224,16 @@ Found outdated information or broken examples? ## Advanced Resources & Integration ### Framework-Specific Guides -- **React/Next.js**: See [integration-patterns.md](integration-patterns.md) → React Integration -- **Vue/Nuxt**: See [integration-patterns.md](integration-patterns.md) → Vue Ecosystem -- **Node.js/Express**: See [integration-patterns.md](integration-patterns.md) → Backend Patterns -- **Python/Django**: See [integration-patterns.md](integration-patterns.md) → Python Workflows +- **React/Next.js**: See [integration-patterns.md](./integration-patterns.md) → React Integration +- **Vue/Nuxt**: See [integration-patterns.md](./integration-patterns.md) → Vue Ecosystem +- **Node.js/Express**: See [integration-patterns.md](./integration-patterns.md) → Backend Patterns +- **Python/Django**: See [integration-patterns.md](./integration-patterns.md) → Python Workflows ### Specialized Workflows -- **DevOps Integration**: [advanced-workflows.md](advanced-workflows.md) → CI/CD Patterns -- **Testing Strategies**: [advanced-patterns.md](advanced-patterns.md) → Testing Orchestration -- **Performance Engineering**: [optimization-guide.md](optimization-guide.md) → Advanced Optimization -- **Security Implementation**: [integration-patterns.md](integration-patterns.md) → Security Patterns +- **DevOps Integration**: [advanced-workflows.md](./advanced-workflows.md) → CI/CD Patterns +- **Testing Strategies**: [advanced-patterns.md](./advanced-patterns.md) → Testing Orchestration +- **Performance Engineering**: [optimization-guide.md](./optimization-guide.md) → Advanced Optimization +- **Security Implementation**: [integration-patterns.md](./integration-patterns.md) → Security Patterns ### Community & Support - **Best Practices**: Continuously updated based on community feedback @@ -243,8 +243,8 @@ Found outdated information or broken examples? --- -**Start Your Journey**: New to SuperClaude? Begin with [quick-start-practices.md](quick-start-practices.md) for immediate productivity gains. +**Start Your Journey**: New to SuperClaude? Begin with [quick-start-practices.md](./quick-start-practices.md) for immediate productivity gains. -**Need Answers Now**: Jump to [basic-examples.md](basic-examples.md) for copy-paste solutions. +**Need Answers Now**: Jump to [basic-examples.md](./basic-examples.md) for copy-paste solutions. -**Ready for Advanced**: Explore [advanced-patterns.md](advanced-patterns.md) for expert-level orchestration. \ No newline at end of file +**Ready for Advanced**: Explore [advanced-patterns.md](./advanced-patterns.md) for expert-level orchestration. \ No newline at end of file diff --git a/Docs/Reference/advanced-patterns.md b/Docs/Reference/advanced-patterns.md index f0d2285..525aff6 100644 --- a/Docs/Reference/advanced-patterns.md +++ b/Docs/Reference/advanced-patterns.md @@ -22,8 +22,8 @@ - [Adaptive Learning Patterns](#adaptive-learning-patterns) - Continuous improvement strategies ### See Also -- [Quick Start Practices](quick-start-practices.md) - Foundation skills and basic workflows -- [Optimization Guide](optimization-guide.md) - Performance and efficiency strategies +- [Quick Start Practices](./quick-start-practices.md) - Foundation skills and basic workflows +- [Optimization Guide](./optimization-guide.md) - Performance and efficiency strategies ## Agent Coordination Excellence @@ -699,7 +699,7 @@ Master these advanced patterns to become a SuperClaude expert: - Apply complex orchestration patterns to enterprise scenarios **Skill Development:** -- [Optimization Guide](optimization-guide.md) - Performance and efficiency mastery +- [Optimization Guide](./optimization-guide.md) - Performance and efficiency mastery - [Technical Architecture](../Developer-Guide/technical-architecture.md) - Deep system understanding **Leadership and Mentoring:** @@ -711,7 +711,7 @@ Master these advanced patterns to become a SuperClaude expert: **Share Your Patterns:** - Document successful coordination strategies -- Contribute to [Examples Cookbook](examples-cookbook.md) +- Contribute to [Examples Cookbook](./examples-cookbook.md) - Share insights in [GitHub Discussions](https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions) **Advanced Learning:** diff --git a/Docs/Reference/diagnostic-reference.md b/Docs/Reference/diagnostic-reference.md index fe35e60..dda6a4f 100644 --- a/Docs/Reference/diagnostic-reference.md +++ b/Docs/Reference/diagnostic-reference.md @@ -997,8 +997,8 @@ EOF - **Log Analysis**: `journalctl`, `tail`, `grep`, `awk` ### SuperClaude-Specific Resources -- **Common Issues**: [common-issues.md](common-issues.md) - Basic troubleshooting procedures -- **MCP Server Guide**: [mcp-server-guide.md](mcp-server-guide.md) - MCP-specific diagnostics +- **Common Issues**: [common-issues.md](./common-issues.md) - Basic troubleshooting procedures +- **MCP Server Guide**: [mcp-server-guide.md](./mcp-server-guide.md) - MCP-specific diagnostics - **Installation Guide**: [../Getting-Started/installation.md](../Getting-Started/installation.md) - Setup procedures - **User Guide**: [../User-Guide/](../User-Guide/) - Operational documentation diff --git a/Docs/Reference/examples-cookbook.md b/Docs/Reference/examples-cookbook.md index 6afd968..9d69f8b 100644 --- a/Docs/Reference/examples-cookbook.md +++ b/Docs/Reference/examples-cookbook.md @@ -6,7 +6,7 @@ ## Recipe Collections Overview -### [Basic Examples Collection](basic-examples.md) +### [Basic Examples Collection](./basic-examples.md) **Essential commands and single-agent workflows** - Copy-paste ready commands for immediate use - Essential SuperClaude patterns and fundamentals @@ -15,7 +15,7 @@ **Best for**: New users, quick task execution, learning fundamentals -### [Advanced Workflows Collection](advanced-workflows.md) +### [Advanced Workflows Collection](./advanced-workflows.md) **Multi-agent coordination and complex orchestration** - Multi-agent collaboration patterns - Enterprise-scale project workflows @@ -24,7 +24,7 @@ **Best for**: Experienced users, enterprise projects, complex coordination -### [Integration Patterns Collection](integration-patterns.md) +### [Integration Patterns Collection](./integration-patterns.md) **Framework integration and cross-tool coordination** - Framework-specific integration patterns - Performance optimization recipes @@ -37,40 +37,40 @@ ### By Experience Level **Beginner (Week 1-2)** -→ Start with [Basic Examples](basic-examples.md) +→ Start with [Basic Examples](./basic-examples.md) - Essential commands and patterns - Simple troubleshooting workflows - Copy-paste solutions for common tasks **Intermediate (Week 3-6)** -→ Progress to [Advanced Workflows](advanced-workflows.md) +→ Progress to [Advanced Workflows](./advanced-workflows.md) - Multi-agent coordination - Complex project orchestration - Session management patterns **Expert (Month 2+)** -→ Master [Integration Patterns](integration-patterns.md) +→ Master [Integration Patterns](./integration-patterns.md) - Framework integration strategies - Performance optimization recipes - Enterprise-scale architecture patterns ### By Use Case **Web Development** -- Frontend: [Basic Examples](basic-examples.md#frontend-component-development) → [Integration Patterns](integration-patterns.md#react-ecosystem-integration) -- Backend: [Basic Examples](basic-examples.md#api-development-basics) → [Integration Patterns](integration-patterns.md#nodejs-backend-integration) -- Full-Stack: [Advanced Workflows](advanced-workflows.md#complete-e-commerce-platform-development) +- Frontend: [Basic Examples](./basic-examples.md#frontend-component-development) → [Integration Patterns](./integration-patterns.md#react-ecosystem-integration) +- Backend: [Basic Examples](./basic-examples.md#api-development-basics) → [Integration Patterns](./integration-patterns.md#nodejs-backend-integration) +- Full-Stack: [Advanced Workflows](./advanced-workflows.md#complete-e-commerce-platform-development) **Mobile Development** -- React Native: [Basic Examples](basic-examples.md#copy-paste-quick-solutions) → [Integration Patterns](integration-patterns.md#mobile-and-web-integration) -- Cross-Platform: [Integration Patterns](integration-patterns.md#cross-platform-integration-patterns) +- React Native: [Basic Examples](./basic-examples.md#copy-paste-quick-solutions) → [Integration Patterns](./integration-patterns.md#mobile-and-web-integration) +- Cross-Platform: [Integration Patterns](./integration-patterns.md#cross-platform-integration-patterns) **DevOps & Infrastructure** -- CI/CD: [Basic Examples](basic-examples.md#copy-paste-quick-solutions) → [Integration Patterns](integration-patterns.md#devops-and-infrastructure-integration) -- Monitoring: [Advanced Workflows](advanced-workflows.md#advanced-monitoring-and-observability) → [Integration Patterns](integration-patterns.md#monitoring-and-observability-patterns) +- CI/CD: [Basic Examples](./basic-examples.md#copy-paste-quick-solutions) → [Integration Patterns](./integration-patterns.md#devops-and-infrastructure-integration) +- Monitoring: [Advanced Workflows](./advanced-workflows.md#advanced-monitoring-and-observability) → [Integration Patterns](./integration-patterns.md#monitoring-and-observability-patterns) **Performance & Security** -- Security: [Basic Examples](basic-examples.md#basic-troubleshooting-examples) → [Advanced Workflows](advanced-workflows.md#enterprise-scale-security-implementation) -- Performance: [Integration Patterns](integration-patterns.md#performance-optimization-recipes) +- Security: [Basic Examples](./basic-examples.md#basic-troubleshooting-examples) → [Advanced Workflows](./advanced-workflows.md#enterprise-scale-security-implementation) +- Performance: [Integration Patterns](./integration-patterns.md#performance-optimization-recipes) ## Verified Commands Reference @@ -96,20 +96,20 @@ ### Phase 1: Foundation (Week 1-2) 1. **Setup**: Complete [Installation Guide](../Getting-Started/installation.md) -2. **Basics**: Practice [Basic Examples](basic-examples.md#essential-one-liner-commands) -3. **Patterns**: Learn [Basic Usage Patterns](basic-examples.md#basic-usage-patterns) +2. **Basics**: Practice [Basic Examples](./basic-examples.md#essential-one-liner-commands) +3. **Patterns**: Learn [Basic Usage Patterns](./basic-examples.md#basic-usage-patterns) 4. **Success**: Can execute common development tasks independently ### Phase 2: Coordination (Week 3-6) -1. **Agents**: Understand [Multi-Agent Patterns](advanced-workflows.md#multi-agent-collaboration-patterns) -2. **Workflows**: Practice [Complex Project Workflows](advanced-workflows.md#complex-project-workflows) -3. **Orchestration**: Master [Advanced Orchestration](advanced-workflows.md#advanced-orchestration-patterns) +1. **Agents**: Understand [Multi-Agent Patterns](./advanced-workflows.md#multi-agent-collaboration-patterns) +2. **Workflows**: Practice [Complex Project Workflows](./advanced-workflows.md#complex-project-workflows) +3. **Orchestration**: Master [Advanced Orchestration](./advanced-workflows.md#advanced-orchestration-patterns) 4. **Success**: Can coordinate complex multi-step projects ### Phase 3: Integration (Month 2+) -1. **Frameworks**: Learn [Framework Integration](integration-patterns.md#framework-integration-patterns) -2. **Performance**: Master [Optimization Recipes](integration-patterns.md#performance-optimization-recipes) -3. **Troubleshooting**: Advanced [Debugging Workflows](integration-patterns.md#advanced-troubleshooting-workflows) +1. **Frameworks**: Learn [Framework Integration](./integration-patterns.md#framework-integration-patterns) +2. **Performance**: Master [Optimization Recipes](./integration-patterns.md#performance-optimization-recipes) +3. **Troubleshooting**: Advanced [Debugging Workflows](./integration-patterns.md#advanced-troubleshooting-workflows) 4. **Success**: Can integrate SuperClaude with any development stack ### Phase 4: Expertise (Month 3+) @@ -122,11 +122,11 @@ | Task Type | Beginner | Intermediate | Expert | |-----------|----------|--------------|--------| -| **Analysis** | [Basic Analysis](basic-examples.md#quick-analysis-commands) | [Multi-Agent Analysis](advanced-workflows.md#performance-optimization-team) | [Integration Analysis](integration-patterns.md#distributed-system-debugging) | -| **Implementation** | [Simple Features](basic-examples.md#simple-feature-implementation) | [Complex Projects](advanced-workflows.md#complex-project-workflows) | [Framework Integration](integration-patterns.md#framework-integration-patterns) | -| **Testing** | [Basic Testing](basic-examples.md#copy-paste-quick-solutions) | [Comprehensive Testing](advanced-workflows.md#advanced-workflows) | [Testing Integration](integration-patterns.md#advanced-testing-integration) | -| **Troubleshooting** | [Common Issues](basic-examples.md#basic-troubleshooting-examples) | [System Debugging](advanced-workflows.md#advanced-workflows) | [Distributed Debugging](integration-patterns.md#advanced-troubleshooting-workflows) | -| **Performance** | [Basic Optimization](basic-examples.md#quick-quality-improvements) | [System Optimization](advanced-workflows.md#performance-optimization-strategies) | [Expert Optimization](integration-patterns.md#performance-optimization-recipes) | +| **Analysis** | [Basic Analysis](./basic-examples.md#quick-analysis-commands) | [Multi-Agent Analysis](./advanced-workflows.md#performance-optimization-team) | [Integration Analysis](./integration-patterns.md#distributed-system-debugging) | +| **Implementation** | [Simple Features](./basic-examples.md#simple-feature-implementation) | [Complex Projects](./advanced-workflows.md#complex-project-workflows) | [Framework Integration](./integration-patterns.md#framework-integration-patterns) | +| **Testing** | [Basic Testing](./basic-examples.md#copy-paste-quick-solutions) | [Comprehensive Testing](./advanced-workflows.md#advanced-workflows) | [Testing Integration](./integration-patterns.md#advanced-testing-integration) | +| **Troubleshooting** | [Common Issues](./basic-examples.md#basic-troubleshooting-examples) | [System Debugging](./advanced-workflows.md#advanced-workflows) | [Distributed Debugging](./integration-patterns.md#advanced-troubleshooting-workflows) | +| **Performance** | [Basic Optimization](./basic-examples.md#quick-quality-improvements) | [System Optimization](./advanced-workflows.md#performance-optimization-strategies) | [Expert Optimization](./integration-patterns.md#performance-optimization-recipes) | ## Success Milestones @@ -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](quick-start-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 @@ -163,10 +163,10 @@ **Advanced**: - [Technical Architecture](../Developer-Guide/technical-architecture.md) - Deep system understanding -- [Troubleshooting Guide](troubleshooting.md) - Common issues and solutions +- [Troubleshooting Guide](./troubleshooting.md) - Common issues and solutions --- -**Your Journey**: Start with [Basic Examples](basic-examples.md), progress through [Advanced Workflows](advanced-workflows.md), and master [Integration Patterns](integration-patterns.md). SuperClaude grows with you from simple commands to sophisticated development orchestration. +**Your Journey**: Start with [Basic Examples](./basic-examples.md), progress through [Advanced Workflows](./advanced-workflows.md), and master [Integration Patterns](./integration-patterns.md). SuperClaude grows with you from simple commands to sophisticated development orchestration. **Remember**: Every expert was once a beginner. Focus on practical application, experiment with different approaches, and leverage the community for support and learning. \ No newline at end of file diff --git a/Docs/Reference/mcp-server-guide.md b/Docs/Reference/mcp-server-guide.md index 327edef..bea0153 100644 --- a/Docs/Reference/mcp-server-guide.md +++ b/Docs/Reference/mcp-server-guide.md @@ -729,8 +729,8 @@ echo "Test MCP servers in Claude Code after restart" ### MCP-Specific Documentation - **Core SuperClaude Guide**: [../User-Guide/mcp-servers.md](../User-Guide/mcp-servers.md) - MCP server overview and usage -- **Common Issues**: [common-issues.md](common-issues.md) - General troubleshooting procedures -- **Diagnostic Reference**: [diagnostic-reference.md](diagnostic-reference.md) - Advanced diagnostic procedures +- **Common Issues**: [common-issues.md](./common-issues.md) - General troubleshooting procedures +- **Diagnostic Reference**: [diagnostic-reference.md](./diagnostic-reference.md) - Advanced diagnostic procedures ### External Resources - **Node.js Official**: [https://nodejs.org/](https://nodejs.org/) - Node.js installation and documentation diff --git a/Docs/Reference/optimization-guide.md b/Docs/Reference/optimization-guide.md index 2fd8868..ca24c22 100644 --- a/Docs/Reference/optimization-guide.md +++ b/Docs/Reference/optimization-guide.md @@ -22,8 +22,8 @@ - [Recovery Strategies](#recovery-strategies) - Issue resolution and optimization ### See Also -- [Quick Start Practices](quick-start-practices.md) - Foundation skills and basic workflows -- [Advanced Patterns](advanced-patterns.md) - Multi-agent coordination and expert techniques +- [Quick Start Practices](./quick-start-practices.md) - Foundation skills and basic workflows +- [Advanced Patterns](./advanced-patterns.md) - Multi-agent coordination and expert techniques ## Speed and Efficiency Strategies @@ -745,7 +745,7 @@ Optimize your SuperClaude usage with these advanced strategies: **Learn from Others:** - [GitHub Discussions](https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions) - Community optimization sharing -- [Examples Cookbook](examples-cookbook.md) - Optimization examples and patterns +- [Examples Cookbook](./examples-cookbook.md) - Optimization examples and patterns --- diff --git a/Docs/Reference/quick-start-practices.md b/Docs/Reference/quick-start-practices.md index 00cdf56..4dfe329 100644 --- a/Docs/Reference/quick-start-practices.md +++ b/Docs/Reference/quick-start-practices.md @@ -18,8 +18,8 @@ - [Common Quick Fixes](#common-quick-fixes) - Immediate problem resolution ### See Also -- [Advanced Patterns](advanced-patterns.md) - Multi-agent coordination and expert techniques -- [Optimization Guide](optimization-guide.md) - Performance and efficiency strategies +- [Advanced Patterns](./advanced-patterns.md) - Multi-agent coordination and expert techniques +- [Optimization Guide](./optimization-guide.md) - Performance and efficiency strategies ## Getting Started Right @@ -617,11 +617,11 @@ For detailed flag documentation, see [Flags Guide](../User-Guide/flags.md). Once you've mastered these quick start practices, explore more advanced capabilities: **Intermediate Level:** -- [Advanced Patterns](advanced-patterns.md) - Multi-agent coordination and complex workflows -- [Examples Cookbook](examples-cookbook.md) - Real-world scenario practice +- [Advanced Patterns](./advanced-patterns.md) - Multi-agent coordination and complex workflows +- [Examples Cookbook](./examples-cookbook.md) - Real-world scenario practice **Advanced Level:** -- [Optimization Guide](optimization-guide.md) - Performance and efficiency mastery +- [Optimization Guide](./optimization-guide.md) - Performance and efficiency mastery - [MCP Servers Guide](../User-Guide/mcp-servers.md) - Enhanced tool integration **Expert Level:** @@ -632,10 +632,10 @@ Once you've mastered these quick start practices, explore more advanced capabili **Learning Support:** - [GitHub Discussions](https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions) - Community help and tips -- [Troubleshooting Guide](troubleshooting.md) - Common issue resolution +- [Troubleshooting Guide](./troubleshooting.md) - Common issue resolution **Practice Materials:** -- [Examples Cookbook](examples-cookbook.md) - Copy-paste solutions for common scenarios +- [Examples Cookbook](./examples-cookbook.md) - Copy-paste solutions for common scenarios - [User Guide](../User-Guide/) - Comprehensive feature documentation --- diff --git a/Docs/Reference/troubleshooting.md b/Docs/Reference/troubleshooting.md index 3539449..086e27b 100644 --- a/Docs/Reference/troubleshooting.md +++ b/Docs/Reference/troubleshooting.md @@ -1,16 +1,16 @@ # SuperClaude Troubleshooting Guide -> **Need a Quick Fix?** For the top 10 most common issues with rapid 2-minute solutions, see the [Common Issues Quick Reference](common-issues.md) first. +> **Need a Quick Fix?** For the top 10 most common issues with rapid 2-minute solutions, see the [Common Issues Quick Reference](./common-issues.md) first. > **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 complex SuperClaude issues, from installation problems to advanced configuration challenges. Each solution includes diagnosis steps, resolution procedures, and prevention strategies. -**When to Use This Guide**: Use this comprehensive guide when the [quick fixes](common-issues.md) don't resolve your issue, or when you need detailed diagnosis and prevention strategies. +**When to Use This Guide**: Use this comprehensive guide when the [quick fixes](./common-issues.md) don't resolve your issue, or when you need detailed diagnosis and prevention strategies. ## Installation Issues -> **🚀 Quick Fix**: For common installation problems like permission denied, Python version issues, or component failures, try the [Common Issues Quick Reference](common-issues.md#top-10-quick-fixes) first. +> **🚀 Quick Fix**: For common installation problems like permission denied, Python version issues, or component failures, try the [Common Issues Quick Reference](./common-issues.md#top-10-quick-fixes) first. ### Advanced Installation Diagnosis @@ -140,7 +140,7 @@ pip install --user SuperClaude ## Command Issues -> **🚀 Quick Fix**: For command recognition problems, timeouts, or basic execution issues, try the [Common Issues Quick Reference](common-issues.md#4--commands-not-working-in-claude-code) first. +> **🚀 Quick Fix**: For command recognition problems, timeouts, or basic execution issues, try the [Common Issues Quick Reference](./common-issues.md#4--commands-not-working-in-claude-code) first. ### Advanced Command Diagnosis @@ -386,7 +386,7 @@ echo "Requirements: vague project, needs discovery" ## MCP Server Issues -> **🚀 Quick Fix**: For Node.js missing or MCP connection problems, see [Common Issues Quick Reference](common-issues.md#8--nodejs-missing-for-mcp-servers) for rapid solutions. +> **🚀 Quick Fix**: For Node.js missing or MCP connection problems, see [Common Issues Quick Reference](./common-issues.md#8--nodejs-missing-for-mcp-servers) for rapid solutions. ### Advanced MCP Diagnosis @@ -750,7 +750,7 @@ python3 -m SuperClaude install --components core agents modes ## Performance Issues -> **🚀 Quick Fix**: For memory errors or resource issues, see [Common Issues Quick Reference](common-issues.md#9--memoryresource-errors) for immediate solutions. +> **🚀 Quick Fix**: For memory errors or resource issues, see [Common Issues Quick Reference](./common-issues.md#9--memoryresource-errors) for immediate solutions. ### Advanced Performance Optimization @@ -1024,7 +1024,7 @@ cat ~/.claude/CLAUDE.md | head -20 3. **Documentation** (Self-Service) - Installation Guide: [../Getting-Started/installation.md](../Getting-Started/installation.md) - Troubleshooting: This guide - - Examples: [examples-cookbook.md](examples-cookbook.md) + - Examples: [examples-cookbook.md](./examples-cookbook.md) **Community Support:** - Community-maintained FAQ and tips @@ -1195,8 +1195,8 @@ time /sc:analyze . --scope module # Module-scoped analysis - [Behavioral Modes](../User-Guide/modes.md) - Mode selection and behavioral troubleshooting **Advanced Topics:** -- [Examples Cookbook](examples-cookbook.md) - Working examples and practical troubleshooting scenarios -- [Best Practices](quick-start-practices.md) - Performance optimization and efficiency troubleshooting +- [Examples Cookbook](./examples-cookbook.md) - Working examples and practical troubleshooting scenarios +- [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 @@ -1215,12 +1215,12 @@ 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](quick-start-practices.md) +- Performance Issues → [Best Practices](./quick-start-practices.md) - Configuration Issues → [MCP Servers](../User-Guide/mcp-servers.md) **Learning Resources:** - New Users → [Quick Start Guide](../Getting-Started/quick-start.md) -- Practical Examples → [Examples Cookbook](examples-cookbook.md) +- Practical Examples → [Examples Cookbook](./examples-cookbook.md) - Advanced Usage → [Technical Architecture](../Developer-Guide/technical-architecture.md) ---