mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-17 17:56:46 +00:00
d5dfd7da21
* refactor(docs): rename directories to lowercase for PEP8 compliance - Developer-Guide → developer-guide - Getting-Started → getting-started - Reference → reference - Templates → templates - User-Guide → user-guide - User-Guide-jp → user-guide-jp - User-Guide-kr → user-guide-kr - User-Guide-zh → user-guide-zh This change aligns with Python PEP8 package naming conventions. All 43 files affected. * refactor: rename root documentation files to lowercase - CHANGELOG.md → changelog.md - CODE_OF_CONDUCT.md → code_of_conduct.md - CONTRIBUTING.md → contributing.md - SECURITY.md → security.md Aligns with Python package naming conventions (PEP8). README files remain uppercase as per convention. * refactor: move documentation files to docs/ for cleaner root Moved OSS standard files to docs/: - CHANGELOG.md → docs/CHANGELOG.md - CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md - CONTRIBUTING.md → docs/CONTRIBUTING.md - SECURITY.md → docs/SECURITY.md Root now contains only essential files: ✓ README files (表紙: en, ja, kr, zh) ✓ LICENSE (法的要件) ✓ Build configs (pyproject.toml, setup.py, MANIFEST.in) ✓ VERSION Rationale: Cleaner root structure following modern Python project conventions. All detailed documentation consolidated in docs/ directory. * refactor: update documentation links after restructure Auto-updated internal documentation links to reflect new structure: - docs/ subdirectories now lowercase (PEP8) - Root files moved to docs/ - All cross-references updated This commit includes linter-generated link updates. * chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY) * chore(docs): remove duplicated PR docs from repo root (moved under docs) * docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity * docs: update links to PM_AGENT.md after rename --------- Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
12 KiB
12 KiB
SuperClaude Framework developer-guide Index
Document Navigation Guide
This index provides comprehensive access to all SuperClaude Framework development documentation, organized by topic and skill level for efficient information discovery.
Quick Navigation
For New Contributors: Start with Contributing Guide → Setup
For System Understanding: Begin with Technical Architecture Guide → Context Architecture
For Verification: Start with Verification Guide → Installation Check
Primary Documentation
📋 Contributing Context Files Guide
Purpose: Complete context file development and contribution guidelines
Target Audience: Framework contributors and context file developers
Length: ~1,000 lines focused on context file reality
Key Sections:
- Development Setup - Environment configuration and prerequisites
- Context File Guidelines - Standards and structure
- Development Workflow - Git workflow and submission process
- Contributing to Components - Agent, command, and mode development
- File Validation - Context file verification methods
🏗️ Context Architecture Guide
Purpose: Understanding how context files work and are structured
Target Audience: Anyone wanting to understand or extend SuperClaude
Length: ~800 lines focused on context file patterns and Claude Code integration
Key Sections:
- Context File Architecture - Directory structure and file types
- The Import System - How Claude Code loads context
- Agent Context Structure - Domain specialist contexts
- Command Context Structure - Workflow patterns
- How Claude Code Reads Context - Processing sequence
- Extending the Framework - Adding new components
🧪 Verification & Troubleshooting Guide
Purpose: Verifying installation and troubleshooting context file issues
Target Audience: Users and maintainers
Length: ~500 lines focused on file verification and Claude Code integration
Key Sections:
- Installation Verification - Check context file installation
- Context File Verification - File structure validation
- MCP Server Verification - External tool configuration
- Common Issues - Troubleshooting activation problems
- Troubleshooting Commands - Diagnostic procedures
Topic-Based Index
🚀 Getting Started
Complete Beginners:
- Contributing Guide → Setup - Environment setup
- Architecture Guide → Overview - Understanding context files
- Verification Guide → Installation Check - Basic verification
Environment Setup:
- Development Setup - Prerequisites and configuration
- Installation Verification - File installation check
🏗️ Architecture & Design
Context File Architecture:
- Context File Architecture - Complete system design
- The Import System - How Claude Code loads context
- Agent Context Structure - Domain specialist patterns
- Command Context Structure - Workflow definitions
Component Development:
- Contributing to Components - Agent, command, mode development
- Adding New Agents - Domain specialist creation
- Adding New Commands - Workflow pattern development
- Extending the Framework - Framework expansion
🧪 Verification & Quality
File Verification:
- Context File Verification - File structure validation
- File Validation - Context file verification methods
Troubleshooting:
- Common Issues - Activation and configuration problems
- Troubleshooting Commands - Diagnostic procedures
🔧 Development Workflows
Context File Development:
- Development Workflow - Git workflow
- Context File Guidelines - Standards and practices
- Pull Request Process - Submission process
Component Development:
- Agent Development - Domain specialist creation
- Command Development - Workflow pattern creation
- Mode Development - Behavioral modification patterns
🛠️ MCP Integration
MCP Configuration:
- MCP Server Configuration - External tool setup
- MCP Server Verification - Configuration validation
🚨 Support & Troubleshooting
Common Issues:
- Commands Not Working - Context trigger problems
- Agents Not Activating - Activation issues
- Context Not Loading - Loading problems
Support Resources:
- Getting Help - Support channels
- Issue Reporting - Bug reports and features
Skill Level Pathways
🟢 Beginner Path (Understanding SuperClaude)
Week 1: Foundation
- Architecture Overview - What SuperClaude is
- Installation Verification - Check your setup
- Context File Architecture - Directory structure
Week 2: Basic Usage
- How Claude Code Reads Context - Processing sequence
- Common Issues - Troubleshooting basics
- Context File Guidelines - File standards
🟡 Intermediate Path (Contributing Context Files)
Month 1: Context Development
- Development Setup - Environment preparation
- Agent Context Structure - Domain specialists
- Command Context Structure - Workflow patterns
Month 2: Component Creation
- Adding New Agents - Domain specialist development
- Adding New Commands - Workflow creation
- File Validation - Context verification
🔴 Advanced Path (Framework Extension)
Advanced Understanding
- The Import System - Context loading mechanics
- Extending the Framework - Framework expansion
- MCP Server Configuration - External tool integration
Reference Materials
📚 Key Concepts
Framework Fundamentals:
- Context-Oriented Configuration Framework
- Agent Domain Specialists
- Command Workflow Patterns
- Mode Behavioral Modifications
- MCP Integration Patterns
🔗 Cross-References
Development → Architecture:
Development → Verification:
Architecture → Verification:
Quality Standards
✅ Documentation Accuracy
- Technical Precision: All examples reflect SuperClaude reality (context files, not software)
- Command Accuracy: Correct Python module execution paths and Claude Code context triggers
- No Fiction: Removed all references to non-existent testing frameworks and performance systems
✅ Content Focus
- Context Files: Documentation centers on .md instruction files and Claude Code behavior
- File Verification: Practical approaches to validating context file installation and structure
- Real Workflows: Actual development processes for context file contribution
✅ User Experience
- Clear Progression: Skill-based learning paths from understanding to contribution
- Practical Examples: Working context file examples and Claude Code integration
- Support Integration: Clear guidance to help resources for real issues
Usage Guidelines
For Contributors
- Start with: Development Setup
- Context Development: Follow Context File Guidelines
- Validation: Use File Validation
- Support: Reference Getting Help
For Architects
- System Understanding: Context File Architecture
- Component Patterns: Agent and Command Structure
- Extension: Extending the Framework
- Integration: MCP Configuration
For Verification
- Installation Check: Installation Verification
- File Validation: Context File Verification
- Troubleshooting: Common Issues
- Diagnostics: Troubleshooting Commands
This comprehensive index reflects the reality of SuperClaude as a context-oriented configuration framework, focusing on practical context file development and Claude Code integration.