mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
Clean up references to deleted scripts and pattern system
- Removed references to validate-references.sh from YAML files - Removed expand-references.sh from settings.local.json - Cleaned up @pattern/@flags references from shared files - Updated documentation to reflect current no-code implementation - Simplified reference-index.yml to remove @include patterns This cleanup removes confusion from the abandoned pattern reference system while maintaining all functionality. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK
@@ -1,85 +1,261 @@
|
||||
@include shared/constants.yml#Process_Symbols
|
||||
# /explain - Provide detailed technical explanations
|
||||
|
||||
@include shared/command-templates.yml#Universal_Flags
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | impl | implementation |
|
||||
| w/ | with | | perf | performance |
|
||||
| @ | at/located | | ops | operations |
|
||||
| > | greater than | | val | validation |
|
||||
| ∀ | for all/every | | req | requirements |
|
||||
| ∃ | exists/there is | | deps | dependencies |
|
||||
| ∴ | therefore | | env | environment |
|
||||
| ∵ | because | | db | database |
|
||||
| ≡ | equivalent | | api | interface |
|
||||
| ≈ | approximately | | docs | documentation |
|
||||
| 📁 | directory/path | | std | standard |
|
||||
| 🔢 | number/count | | def | default |
|
||||
| 📝 | text/string | | ctx | context |
|
||||
| ⚙ | setting/config | | err | error |
|
||||
| 🎛 | control/flags | | exec | execution |
|
||||
| 🔧 | configuration | | qual | quality |
|
||||
| 📋 | group/category | | rec | recovery |
|
||||
| 🚨 | critical/urgent | | sev | severity |
|
||||
| ⚠ | warning/caution | | resp | response |
|
||||
| 🔄 | retry/recovery | | esc | escalation |
|
||||
| ✅ | success/fixed | | tok | token |
|
||||
| ❌ | failure/error | | opt | optimization |
|
||||
| ℹ | information | | UX | user experience |
|
||||
| ⚡ | fast/quick | | UI | user interface |
|
||||
| 🐌 | slow/delayed | | C | critical |
|
||||
| ✨ | complete/done | | H | high |
|
||||
| 📖 | read operation | | M | medium |
|
||||
| ✏ | edit operation | | L | low |
|
||||
| 🗑 | delete operation | | |
|
||||
|
||||
Provide comprehensive explanations of concepts, code, or systems in $ARGUMENTS.
|
||||
## Purpose
|
||||
Provide comprehensive explanations of concepts, code, or systems specified in $ARGUMENTS with appropriate depth and visual aids.
|
||||
|
||||
Thinking flags (optional):
|
||||
- --think→multi-concept explanation w/ connections
|
||||
- --think-hard→complex system explanations w/ deep analysis
|
||||
- --ultrathink→comprehensive knowledge synthesis & teaching
|
||||
## Syntax
|
||||
`/explain [flags] [concept/topic]`
|
||||
|
||||
MCP flags (optional):
|
||||
- --c7→fetch official lib/framework docs | --seq→step-by-step concept breakdown
|
||||
- --no-mcp→explain using only codebase context
|
||||
## Universal Flags
|
||||
--plan: "Show execution plan before running"
|
||||
--uc: "UltraCompressed mode (~70% token reduction)"
|
||||
--ultracompressed: "Alias for --uc"
|
||||
--think: "Multi-file analysis w/ context (4K tokens)"
|
||||
--think-hard: "Deep architectural analysis (10K tokens)"
|
||||
--ultrathink: "Critical system redesign (32K tokens)"
|
||||
--c7: "Enable Context7→library documentation lookup"
|
||||
--seq: "Enable Sequential→complex analysis & thinking"
|
||||
--magic: "Enable Magic→UI component generation"
|
||||
--pup: "Enable Puppeteer→browser automation & testing"
|
||||
--all-mcp: "Enable all MCP servers"
|
||||
--no-mcp: "Disable all MCP servers (native tools only)"
|
||||
--no-c7: "Disable Context7 specifically"
|
||||
--no-seq: "Disable Sequential thinking specifically"
|
||||
--no-magic: "Disable Magic UI builder specifically"
|
||||
--no-pup: "Disable Puppeteer specifically"
|
||||
|
||||
Doc flags:
|
||||
- --ultracompressed or --uc→7 0% token reduction in explanations
|
||||
## Command-Specific Flags
|
||||
|
||||
Examples:
|
||||
- `/user:explain --c7 "React hooks" --think` - React hooks w/ contextual connections
|
||||
- `/user:explain --seq "OAuth flow" --think-hard` - Deep OAuth analysis w/ security implications
|
||||
- `/user:explain --depth advanced --c7 --ultrathink` - Comprehensive system explanation
|
||||
**Explanation Depth:**
|
||||
- `--depth eli5`: Simple analogies, avoid jargon, focus on core concepts
|
||||
- `--depth beginner`: Cover basics with step-by-step guidance and simple examples
|
||||
- `--depth intermediate`: Technical details, best practices, common patterns
|
||||
- `--depth expert`: Deep implementation details, edge cases, performance considerations
|
||||
|
||||
--depth flag levels:
|
||||
- ELI5: Simple analogies, avoid jargon, focus→concepts
|
||||
- Beginner: Cover basics, step-by-step guidance, simple examples
|
||||
- Intermediate: Tech details, best practices, common patterns
|
||||
- Expert: Deep impl details, edge cases, perf considerations
|
||||
**Content Enhancement:**
|
||||
- `--visual`: Create diagrams using Mermaid syntax, ASCII art, flowcharts
|
||||
- `--examples`: Include practical, runnable code examples
|
||||
- `--comparisons`: Add comparison tables and pros/cons analysis
|
||||
- `--interactive`: Create interactive explanations with guided discovery
|
||||
|
||||
When --visual flag is present:
|
||||
- Create diagrams using Mermaid syntax
|
||||
- Use ASCII art for simple visualizations
|
||||
- Include flowcharts for processes
|
||||
- Add sequence diagrams for interactions
|
||||
**Research Integration:**
|
||||
- `--c7`: Fetch official library/framework documentation
|
||||
- `--seq`: Step-by-step concept breakdown with complex analysis
|
||||
- `--no-mcp`: Explain using only codebase context
|
||||
|
||||
Structure the explanation:
|
||||
1. Start with a high-level overview
|
||||
2. Break down into logical components
|
||||
3. Explain each component with appropriate depth
|
||||
4. Show relationships and interactions
|
||||
5. Provide concrete examples
|
||||
**Output Format:**
|
||||
- `--structured`: Organize explanation with clear sections and hierarchy
|
||||
- `--quick`: Concise explanation focusing on key points
|
||||
- `--comprehensive`: Complete explanation covering all aspects
|
||||
|
||||
Include relevant formats:
|
||||
- Code examples that can be run and tested
|
||||
- Comparison tables for alternatives
|
||||
- Pros and cons lists for decisions
|
||||
- Links to authoritative resources
|
||||
## Examples
|
||||
- `/explain --c7 "React hooks" --visual --think` → React hooks with diagrams and connections
|
||||
- `/explain --seq "OAuth flow" --depth expert --think-hard` → Deep OAuth analysis with security implications
|
||||
- `/explain --depth eli5 "async/await" --examples` → Simple async explanation with examples
|
||||
- `/explain --visual --comparisons "REST vs GraphQL"` → API comparison with diagrams
|
||||
- `/explain --comprehensive --c7 "Docker containers"` → Complete Docker explanation with docs
|
||||
|
||||
For technical concepts:
|
||||
- Explain the "what" before the "how"
|
||||
- Connect to familiar concepts when possible
|
||||
- Build understanding incrementally
|
||||
## Explanation Structure
|
||||
|
||||
**1. High-Level Overview:**
|
||||
- Start with the big picture
|
||||
- Define the problem or concept
|
||||
- Explain why it matters
|
||||
- Set context and scope
|
||||
|
||||
**2. Core Components:**
|
||||
- Break down into logical parts
|
||||
- Explain each component clearly
|
||||
- Show relationships and dependencies
|
||||
- Use appropriate technical depth
|
||||
|
||||
**3. Practical Application:**
|
||||
- Provide concrete examples
|
||||
- Show real-world usage
|
||||
- Include code snippets
|
||||
- Demonstrate best practices
|
||||
|
||||
**4. Advanced Concepts:**
|
||||
- Cover edge cases and gotchas
|
||||
- Explain performance implications
|
||||
- Discuss alternatives and trade-offs
|
||||
- Address common misconceptions
|
||||
|
||||
For code explanations:
|
||||
## Content Types
|
||||
|
||||
**Technical Concepts:**
|
||||
- Explain "what" before "how"
|
||||
- Connect to familiar concepts
|
||||
- Build understanding incrementally
|
||||
- Use analogies and metaphors
|
||||
- Address common misconceptions
|
||||
|
||||
**Code Explanations:**
|
||||
- Walk through logic step by step
|
||||
- Explain design decisions
|
||||
- Explain design decisions and rationale
|
||||
- Highlight important patterns
|
||||
- Point out potential gotchas
|
||||
- Point out potential pitfalls
|
||||
- Show alternative approaches
|
||||
|
||||
## UltraCompressed Mode
|
||||
**System Architecture:**
|
||||
- Start with overall design
|
||||
- Explain component interactions
|
||||
- Show data flow and processes
|
||||
- Discuss scalability and performance
|
||||
- Cover security considerations
|
||||
|
||||
When --ultracompressed flag is present:
|
||||
- Apply shared/ultracompressed.yml rules
|
||||
- Generate legend for symbols/abbreviations used
|
||||
- Compress explanations to ~30% of normal size
|
||||
- Use telegram-style: remove articles, use symbols
|
||||
- Format: lists>paragraphs, tables>prose
|
||||
- Example: "fn takes 3 params→bool" instead of "The function takes three parameters and returns a boolean value"
|
||||
**Framework/Library Usage:**
|
||||
- Explain core concepts first
|
||||
- Show common usage patterns
|
||||
- Provide working examples
|
||||
- Explain configuration options
|
||||
- Cover troubleshooting tips
|
||||
|
||||
Research requirements for explanations:
|
||||
- Technical concepts → C7 documentation for authoritative explanations and examples
|
||||
- Framework patterns → Must verify with official guides and documentation
|
||||
- Best practices → WebSearch for current industry standards and expert opinions
|
||||
- Code examples → Research working patterns from official documentation
|
||||
- Never explain without verification - always cite authoritative sources
|
||||
- All explanations must include sources: // Source: [documentation reference]
|
||||
## Visual Aids (--visual)
|
||||
|
||||
Report Output:
|
||||
- Explanation summaries: `.claudedocs/summaries/explanation-<topic>-<timestamp>.md`
|
||||
- Learning resources: `.claudedocs/reports/learning-resources-<timestamp>.md`
|
||||
- Ensure directory exists: `mkdir -p .claudedocs/summaries/ .claudedocs/reports/`
|
||||
- Include report location in output: "📚 Explanation saved to: [path]"
|
||||
**Diagram Types:**
|
||||
- **Mermaid Diagrams**: Flowcharts, sequence diagrams, class diagrams
|
||||
- **ASCII Art**: Simple visualizations and layouts
|
||||
- **Process Flows**: Step-by-step workflow diagrams
|
||||
- **Architecture Diagrams**: System component relationships
|
||||
|
||||
Deliverables: Clear explanation at the appropriate depth level, working examples, visual aids if requested, curated resources for further learning, and comprehensive source references.
|
||||
**When to Use Visuals:**
|
||||
- Complex processes or workflows
|
||||
- System architecture explanations
|
||||
- Data flow and transformations
|
||||
- Relationship mapping
|
||||
- Timeline or sequence explanations
|
||||
|
||||
## Research Requirements
|
||||
|
||||
**Authoritative Sources:**
|
||||
- Official documentation via `--c7`
|
||||
- Framework guides and best practices
|
||||
- Industry standards and specifications
|
||||
- Expert opinions and case studies
|
||||
|
||||
**Verification Standards:**
|
||||
- Never explain without verification
|
||||
- Always cite authoritative sources
|
||||
- Test code examples before including
|
||||
- Validate against current versions
|
||||
- Include source references in explanations
|
||||
|
||||
## UltraCompressed Mode (--uc)
|
||||
|
||||
**Compression Rules:**
|
||||
- ~70% token reduction from standard explanations
|
||||
- Generate legend for symbols/abbreviations
|
||||
- Use telegram-style formatting
|
||||
- Structure: lists > paragraphs, tables > prose
|
||||
- Remove articles, conjunctions, fillers
|
||||
- Focus on essential information only
|
||||
|
||||
**Example Transformation:**
|
||||
- Standard: "The function takes three parameters and returns a boolean value"
|
||||
- Compressed: "fn takes 3 params→bool"
|
||||
|
||||
## Deliverables
|
||||
- **Clear Explanations**: Appropriate depth level with structured content
|
||||
- **Working Examples**: Tested, runnable code snippets
|
||||
- **Visual Aids**: Diagrams, charts, and illustrations (if requested)
|
||||
- **Learning Resources**: Curated resources for further study
|
||||
- **Source References**: Comprehensive citations and links
|
||||
|
||||
## Output Locations
|
||||
- **Explanations**: `.claudedocs/summaries/explanation-{topic}-{timestamp}.md`
|
||||
- **Learning Resources**: `.claudedocs/reports/learning-resources-{timestamp}.md`
|
||||
- **Code Examples**: Embedded in explanation files
|
||||
|
||||
## Research Requirements
|
||||
External_Library_Research:
|
||||
- Identify library/framework mentioned
|
||||
- Context7 lookup for official documentation
|
||||
- Verify API patterns and examples
|
||||
- Check version compatibility
|
||||
- Document findings in implementation
|
||||
Pattern_Research:
|
||||
- Search existing codebase for similar patterns
|
||||
- Magic component search if UI-related
|
||||
- WebSearch for official documentation
|
||||
- Validate approach with Sequential thinking
|
||||
- Document pattern choice rationale
|
||||
API_Integration_Research:
|
||||
- Official documentation lookup
|
||||
- Authentication requirements
|
||||
- Rate limiting and error handling
|
||||
- SDK availability and examples
|
||||
- Integration testing approach
|
||||
|
||||
## Report Notifications
|
||||
📄 Analysis report saved to: {path}
|
||||
📊 Metrics updated: {path}
|
||||
📋 Summary saved to: {path}
|
||||
💾 Checkpoint created: {path}
|
||||
📚 Documentation created: {path}
|
||||
📁 Created directory: {path}
|
||||
✅ {operation} completed successfully
|
||||
❌ {operation} failed: {reason}
|
||||
⚠ {operation} completed w/ warnings
|
||||
|
||||
## Best Practices
|
||||
|
||||
**Effective Explanations:**
|
||||
- Start simple, build complexity gradually
|
||||
- Use concrete examples and analogies
|
||||
- Address the audience's experience level
|
||||
- Anticipate and answer common questions
|
||||
- Provide multiple perspectives when helpful
|
||||
|
||||
**Quality Standards:**
|
||||
- Verify all technical information
|
||||
- Test all code examples
|
||||
- Keep explanations current and accurate
|
||||
- Use clear, precise language
|
||||
- Structure content logically
|
||||
|
||||
## Troubleshooting
|
||||
- **Complex Topics**: Use `--seq --think-hard` for step-by-step breakdown
|
||||
- **Framework Questions**: Combine `--c7 --examples` for comprehensive coverage
|
||||
- **Beginner Audiences**: Use `--depth eli5 --visual --examples`
|
||||
- **Expert Deep Dives**: Apply `--depth expert --comprehensive --ultrathink`
|
||||
|
||||
## Success Messages
|
||||
✅ {operation} completed successfully
|
||||
📝 Created: {file_path}
|
||||
✏ Updated: {file_path}
|
||||
✨ Task completed: {task_title}
|
||||
|
||||
Reference in New Issue
Block a user