External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-18 02:06:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
SuperClaude/docs/Developer-Guide/documentation-index.md
kazuki nakai 050d5ea2ab
refactor: PEP8 compliance - directory rename and code formatting (#425) 
* fix(orchestration): add WebFetch auto-trigger for infrastructure configuration

Problem: Infrastructure configuration changes (e.g., Traefik port settings)
were being made based on assumptions without consulting official documentation,
violating the 'Evidence > assumptions' principle in PRINCIPLES.md.

Solution:
- Added Infrastructure Configuration Validation section to MODE_Orchestration.md
- Auto-triggers WebFetch for infrastructure tools (Traefik, nginx, Docker, etc.)
- Enforces MODE_DeepResearch activation for investigation
- BLOCKS assumption-based configuration changes

Testing: Verified WebFetch successfully retrieves Traefik official docs (port 80 default)

This prevents production outages from infrastructure misconfiguration by ensuring
all technical recommendations are backed by official documentation.

* feat: Add PM Agent (Project Manager Agent) for seamless orchestration

Introduces PM Agent as the default orchestration layer that coordinates
all sub-agents and manages workflows automatically.

Key Features:
- Default orchestration: All user interactions handled by PM Agent
- Auto-delegation: Intelligent sub-agent selection based on task analysis
- Docker Gateway integration: Zero-token baseline with dynamic MCP loading
- Self-improvement loop: Automatic documentation of patterns and mistakes
- Optional override: Users can specify sub-agents explicitly if desired

Architecture:
- Agent spec: SuperClaude/Agents/pm-agent.md
- Command: SuperClaude/Commands/pm.md
- Updated docs: README.md (15→16 agents), agents.md (new Orchestration category)

User Experience:
- Default: PM Agent handles everything (seamless, no manual routing)
- Optional: Explicit --agent flag for direct sub-agent access
- Both modes available simultaneously (no user downside)

Implementation Status:
- ✅ Specification complete
- ✅ Documentation complete
- ⏳ Prototype implementation needed
- ⏳ Docker Gateway integration needed
- ⏳ Testing and validation needed

Refs: kazukinakai/docker-mcp-gateway (IRIS MCP Gateway integration)

* feat: Add Agent Orchestration rules for PM Agent default activation

Implements PM Agent as the default orchestration layer in RULES.md.

Key Changes:
- New 'Agent Orchestration' section (CRITICAL priority)
- PM Agent receives ALL user requests by default
- Manual override with @agent-[name] bypasses PM Agent
- Agent Selection Priority clearly defined:
  1. Manual override → Direct routing
  2. Default → PM Agent → Auto-delegation
  3. Delegation based on keywords, file types, complexity, context

User Experience:
- Default: PM Agent handles everything (seamless)
- Override: @agent-[name] for direct specialist access
- Transparent: PM Agent reports delegation decisions

This establishes PM Agent as the orchestration layer while
respecting existing auto-activation patterns and manual overrides.

Next Steps:
- Local testing in agiletec project
- Iteration based on actual behavior
- Documentation updates as needed

* refactor(pm-agent): redesign as self-improvement meta-layer

Problem Resolution:
PM Agent's initial design competed with existing auto-activation for task routing,
creating confusion about orchestration responsibilities and adding unnecessary complexity.

Design Change:
Redefined PM Agent as a meta-layer agent that operates AFTER specialist agents
complete tasks, focusing on:
- Post-implementation documentation and pattern recording
- Immediate mistake analysis with prevention checklists
- Monthly documentation maintenance and noise reduction
- Pattern extraction and knowledge synthesis

Two-Layer Orchestration System:
1. Task Execution Layer: Existing auto-activation handles task routing (unchanged)
2. Self-Improvement Layer: PM Agent meta-layer handles documentation (new)

Files Modified:
- SuperClaude/Agents/pm-agent.md: Complete rewrite with meta-layer design
  - Category: orchestration → meta
  - Triggers: All user interactions → Post-implementation, mistakes, monthly
  - Behavioral Mindset: Continuous learning system
  - Self-Improvement Workflow: BEFORE/DURING/AFTER/MISTAKE RECOVERY/MAINTENANCE

- SuperClaude/Core/RULES.md: Agent Orchestration section updated
  - Split into Task Execution Layer + Self-Improvement Layer
  - Added orchestration flow diagram
  - Clarified PM Agent activates AFTER task completion

- README.md: Updated PM Agent description
  - "orchestrates all interactions" → "ensures continuous learning"

- Docs/User-Guide/agents.md: PM Agent section rewritten
  - Section: Orchestration Agent → Meta-Layer Agent
  - Expertise: Project orchestration → Self-improvement workflow executor
  - Examples: Task coordination → Post-implementation documentation

- PR_DOCUMENTATION.md: Comprehensive PR documentation added
  - Summary, motivation, changes, testing, breaking changes
  - Two-layer orchestration system diagram
  - Verification checklist

Integration Validated:
Tested with agiletec project's self-improvement-workflow.md:
✅ PM Agent aligns with existing BEFORE/DURING/AFTER/MISTAKE RECOVERY phases
✅ Complements (not competes with) existing workflow
✅ agiletec workflow defines WHAT, PM Agent defines WHO executes it

Breaking Changes: None
- Existing auto-activation continues unchanged
- Specialist agents unaffected
- User workflows remain the same
- New capability: Automatic documentation and knowledge maintenance

Value Proposition:
Transforms SuperClaude into a continuously learning system that accumulates
knowledge, prevents recurring mistakes, and maintains fresh documentation
without manual intervention.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: add Claude Code conversation history management research

Research covering .jsonl file structure, performance impact, and retention policies.

Content:
- Claude Code .jsonl file format and message types
- Performance issues from GitHub (memory leaks, conversation compaction)
- Retention policies (consumer vs enterprise)
- Rotation recommendations based on actual data
- File history snapshot tracking mechanics

Source: Moved from agiletec project (research applicable to all Claude Code projects)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: add Development documentation structure

Phase 1: Documentation Structure complete

- Add Docs/Development/ directory for development documentation
- Add ARCHITECTURE.md - System architecture with PM Agent meta-layer
- Add ROADMAP.md - 5-phase development plan with checkboxes
- Add TASKS.md - Daily task tracking with progress indicators
- Add PROJECT_STATUS.md - Current status dashboard and metrics
- Add pm-agent-integration.md - Implementation guide for PM Agent mode

This establishes comprehensive documentation foundation for:
- System architecture understanding
- Development planning and tracking
- Implementation guidance
- Progress visibility

Related: #pm-agent-mode #documentation #phase-1

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: PM Agent session lifecycle and PDCA implementation

Phase 2: PM Agent Mode Integration (Design Phase)

Commands/pm.md updates:
- Add "Always-Active Foundation Layer" concept
- Add Session Lifecycle (Session Start/During Work/Session End)
- Add PDCA Cycle (Plan/Do/Check/Act) automation
- Add Serena MCP Memory Integration (list/read/write_memory)
- Document auto-activation triggers

Agents/pm-agent.md updates:
- Add Session Start Protocol (MANDATORY auto-activation)
- Add During Work PDCA Cycle with example workflows
- Add Session End Protocol with state preservation
- Add PDCA Self-Evaluation Pattern
- Add Documentation Strategy (temp → patterns/mistakes)
- Add Memory Operations Reference

Key Features:
- Session start auto-activation for context restoration
- 30-minute checkpoint saves during work
- Self-evaluation with think_about_* operations
- Systematic documentation lifecycle
- Knowledge evolution to CLAUDE.md

Implementation Status:
- ✅ Design complete (Commands/pm.md, Agents/pm-agent.md)
- ⏳ Implementation pending (Core components)
- ⏳ Serena MCP integration pending

Salvaged from mistaken development in ~/.claude directory

Related: #pm-agent-mode #session-lifecycle #pdca-cycle #phase-2

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: disable Serena MCP auto-browser launch

Disable web dashboard and GUI log window auto-launch in Serena MCP server
to prevent intrusive browser popups on startup. Users can still manually
access the dashboard at http://localhost:24282/dashboard/ if needed.

Changes:
- Add CLI flags to Serena run command:
  - --enable-web-dashboard false
  - --enable-gui-log-window false
- Ensures Git-tracked configuration (no reliance on ~/.serena/serena_config.yml)
- Aligns with AIRIS MCP Gateway integration approach

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor: rename directories to lowercase for PEP8 compliance

- Rename superclaude/Agents -> superclaude/agents
- Rename superclaude/Commands -> superclaude/commands
- Rename superclaude/Core -> superclaude/core
- Rename superclaude/Examples -> superclaude/examples
- Rename superclaude/MCP -> superclaude/mcp
- Rename superclaude/Modes -> superclaude/modes

This change follows Python PEP8 naming conventions for package directories.

* style: fix PEP8 violations and update package name to lowercase

Changes:
- Format all Python files with black (43 files reformatted)
- Update package name from 'SuperClaude' to 'superclaude' in pyproject.toml
- Fix import statements to use lowercase package name
- Add missing imports (timedelta, __version__)
- Remove old SuperClaude.egg-info directory

PEP8 violations reduced from 2672 to 701 (mostly E501 line length due to black's 88 char vs flake8's 79 char limit).

* docs: add PM Agent development documentation

Add comprehensive PM Agent development documentation:
- PM Agent ideal workflow (7-phase autonomous cycle)
- Project structure understanding (Git vs installed environment)
- Installation flow understanding (CommandsComponent behavior)
- Task management system (current-tasks.md)

Purpose: Eliminate repeated explanations and enable autonomous PDCA cycles

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat(pm-agent): add self-correcting execution and warning investigation culture

## Changes

### superclaude/commands/pm.md
- Add "Self-Correcting Execution" section with root cause analysis protocol
- Add "Warning/Error Investigation Culture" section enforcing zero-tolerance for dismissal
- Define error detection protocol: STOP → Investigate → Hypothesis → Different Solution → Execute
- Document anti-patterns (retry without understanding) and correct patterns (research-first)

### docs/Development/hypothesis-pm-autonomous-enhancement-2025-10-14.md
- Add PDCA workflow hypothesis document for PM Agent autonomous enhancement

## Rationale

PM Agent must never retry failed operations without understanding root causes.
All warnings and errors require investigation via context7/WebFetch/documentation
to ensure production-quality code and prevent technical debt accumulation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat(installer): add airis-mcp-gateway MCP server option

## Changes

- Add airis-mcp-gateway to MCP server options in installer
- Configuration: GitHub-based installation via uvx
- Repository: https://github.com/oraios/airis-mcp-gateway
- Purpose: Dynamic MCP Gateway for zero-token baseline and on-demand tool loading

## Implementation

Added to setup/components/mcp.py self.mcp_servers dictionary with:
- install_method: github
- install_command: uvx test installation
- run_command: uvx runtime execution
- required: False (optional server)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
Co-authored-by: Claude <noreply@anthropic.com>
2025-10-14 08:47:09 +05:30

227 lines
12 KiB
Markdown
Raw Blame History

# 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](contributing-code.md#development-setup)
**For System Understanding**: Begin with [Technical Architecture Guide → Context Architecture](technical-architecture.md#context-file-architecture)
**For Verification**: Start with [Verification Guide → Installation Check](testing-debugging.md#installation-verification)
---
## Primary Documentation
### 📋 [Contributing Context Files Guide](contributing-code.md)
**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](contributing-code.md#development-setup) - Environment configuration and prerequisites
- [Context File Guidelines](contributing-code.md#context-file-guidelines) - Standards and structure
- [Development Workflow](contributing-code.md#development-workflow) - Git workflow and submission process
- [Contributing to Components](contributing-code.md#contributing-to-components) - Agent, command, and mode development
- [File Validation](contributing-code.md#file-validation) - Context file verification methods
### 🏗️ [Context Architecture Guide](technical-architecture.md)
**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](technical-architecture.md#context-file-architecture) - Directory structure and file types
- [The Import System](technical-architecture.md#the-import-system) - How Claude Code loads context
- [Agent Context Structure](technical-architecture.md#agent-context-structure) - Domain specialist contexts
- [Command Context Structure](technical-architecture.md#command-context-structure) - Workflow patterns
- [How Claude Code Reads Context](technical-architecture.md#how-claude-code-reads-context) - Processing sequence
- [Extending the Framework](technical-architecture.md#extending-the-framework) - Adding new components
### 🧪 [Verification & Troubleshooting Guide](testing-debugging.md)
**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](testing-debugging.md#installation-verification) - Check context file installation
- [Context File Verification](testing-debugging.md#context-file-verification) - File structure validation
- [MCP Server Verification](testing-debugging.md#mcp-server-verification) - External tool configuration
- [Common Issues](testing-debugging.md#common-issues) - Troubleshooting activation problems
- [Troubleshooting Commands](testing-debugging.md#troubleshooting-commands) - Diagnostic procedures
---
## Topic-Based Index
### 🚀 Getting Started
**Complete Beginners**:
1. [Contributing Guide → Setup](contributing-code.md#development-setup) - Environment setup
2. [Architecture Guide → Overview](technical-architecture.md#overview) - Understanding context files
3. [Verification Guide → Installation Check](testing-debugging.md#installation-verification) - Basic verification
**Environment Setup**:
- [Development Setup](contributing-code.md#development-setup) - Prerequisites and configuration
- [Installation Verification](testing-debugging.md#installation-verification) - File installation check
### 🏗️ Architecture & Design
**Context File Architecture**:
- [Context File Architecture](technical-architecture.md#context-file-architecture) - Complete system design
- [The Import System](technical-architecture.md#the-import-system) - How Claude Code loads context
- [Agent Context Structure](technical-architecture.md#agent-context-structure) - Domain specialist patterns
- [Command Context Structure](technical-architecture.md#command-context-structure) - Workflow definitions
**Component Development**:
- [Contributing to Components](contributing-code.md#contributing-to-components) - Agent, command, mode development
- [Adding New Agents](contributing-code.md#adding-new-agents) - Domain specialist creation
- [Adding New Commands](contributing-code.md#adding-new-commands) - Workflow pattern development
- [Extending the Framework](technical-architecture.md#extending-the-framework) - Framework expansion
### 🧪 Verification & Quality
**File Verification**:
- [Context File Verification](testing-debugging.md#context-file-verification) - File structure validation
- [File Validation](contributing-code.md#file-validation) - Context file verification methods
**Troubleshooting**:
- [Common Issues](testing-debugging.md#common-issues) - Activation and configuration problems
- [Troubleshooting Commands](testing-debugging.md#troubleshooting-commands) - Diagnostic procedures
### 🔧 Development Workflows
**Context File Development**:
- [Development Workflow](contributing-code.md#development-workflow) - Git workflow
- [Context File Guidelines](contributing-code.md#context-file-guidelines) - Standards and practices
- [Pull Request Process](contributing-code.md#pull-request-template) - Submission process
**Component Development**:
- [Agent Development](contributing-code.md#adding-new-agents) - Domain specialist creation
- [Command Development](contributing-code.md#adding-new-commands) - Workflow pattern creation
- [Mode Development](contributing-code.md#adding-new-modes) - Behavioral modification patterns
### 🛠️ MCP Integration
**MCP Configuration**:
- [MCP Server Configuration](technical-architecture.md#mcp-server-configuration) - External tool setup
- [MCP Server Verification](testing-debugging.md#mcp-server-verification) - Configuration validation
### 🚨 Support & Troubleshooting
**Common Issues**:
- [Commands Not Working](testing-debugging.md#issue-commands-not-working) - Context trigger problems
- [Agents Not Activating](testing-debugging.md#issue-agents-not-activating) - Activation issues
- [Context Not Loading](testing-debugging.md#issue-context-not-loading) - Loading problems
**Support Resources**:
- [Getting Help](contributing-code.md#getting-help) - Support channels
- [Issue Reporting](contributing-code.md#issue-reporting) - Bug reports and features
---
## Skill Level Pathways
### 🟢 Beginner Path (Understanding SuperClaude)
**Week 1: Foundation**
1. [Architecture Overview](technical-architecture.md#overview) - What SuperClaude is
2. [Installation Verification](testing-debugging.md#installation-verification) - Check your setup
3. [Context File Architecture](technical-architecture.md#context-file-architecture) - Directory structure
**Week 2: Basic Usage**
1. [How Claude Code Reads Context](technical-architecture.md#how-claude-code-reads-context) - Processing sequence
2. [Common Issues](testing-debugging.md#common-issues) - Troubleshooting basics
3. [Context File Guidelines](contributing-code.md#context-file-guidelines) - File standards
### 🟡 Intermediate Path (Contributing Context Files)
**Month 1: Context Development**
1. [Development Setup](contributing-code.md#development-setup) - Environment preparation
2. [Agent Context Structure](technical-architecture.md#agent-context-structure) - Domain specialists
3. [Command Context Structure](technical-architecture.md#command-context-structure) - Workflow patterns
**Month 2: Component Creation**
1. [Adding New Agents](contributing-code.md#adding-new-agents) - Domain specialist development
2. [Adding New Commands](contributing-code.md#adding-new-commands) - Workflow creation
3. [File Validation](contributing-code.md#file-validation) - Context verification
### 🔴 Advanced Path (Framework Extension)
**Advanced Understanding**
1. [The Import System](technical-architecture.md#the-import-system) - Context loading mechanics
2. [Extending the Framework](technical-architecture.md#extending-the-framework) - Framework expansion
3. [MCP Server Configuration](technical-architecture.md#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**:
- [Context File Guidelines](contributing-code.md#context-file-guidelines) → [Context File Architecture](technical-architecture.md#context-file-architecture)
- [Adding Components](contributing-code.md#contributing-to-components) → [Agent/Command Structure](technical-architecture.md#agent-context-structure)
**Development → Verification**:
- [Development Workflow](contributing-code.md#development-workflow) → [File Verification](testing-debugging.md#context-file-verification)
- [File Validation](contributing-code.md#file-validation) → [Installation Verification](testing-debugging.md#installation-verification)
**Architecture → Verification**:
- [How Claude Code Reads Context](technical-architecture.md#how-claude-code-reads-context) → [Troubleshooting](testing-debugging.md#common-issues)
- [MCP Configuration](technical-architecture.md#mcp-server-configuration) → [MCP Verification](testing-debugging.md#mcp-server-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
1. **Start with**: [Development Setup](contributing-code.md#development-setup)
2. **Context Development**: Follow [Context File Guidelines](contributing-code.md#context-file-guidelines)
3. **Validation**: Use [File Validation](contributing-code.md#file-validation)
4. **Support**: Reference [Getting Help](contributing-code.md#getting-help)
### For Architects
1. **System Understanding**: [Context File Architecture](technical-architecture.md#context-file-architecture)
2. **Component Patterns**: [Agent and Command Structure](technical-architecture.md#agent-context-structure)
3. **Extension**: [Extending the Framework](technical-architecture.md#extending-the-framework)
4. **Integration**: [MCP Configuration](technical-architecture.md#mcp-server-configuration)
### For Verification
1. **Installation Check**: [Installation Verification](testing-debugging.md#installation-verification)
2. **File Validation**: [Context File Verification](testing-debugging.md#context-file-verification)
3. **Troubleshooting**: [Common Issues](testing-debugging.md#common-issues)
4. **Diagnostics**: [Troubleshooting Commands](testing-debugging.md#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.
Reference in New Issue View Git Blame Copy Permalink