mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
d24503ca02
- Migrate all command files to use @include reference system - Consolidate shared patterns into new yml structure - Create central superclaude shared configuration files - Remove deprecated markdown files (MCP.md, PERSONAS.md, RULES.md) - Add new documentation structure in docs/ - Update installation script for new architecture - Add ROADMAP.md and VERSION files This completes the major architectural refactor to improve maintainability and reduce duplication across the SuperClaude command system. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
**Purpose**: Professional documentation creation
|
|
|
|
---
|
|
|
|
@include shared/universal-constants.yml#Universal_Legend
|
|
|
|
## Command Execution
|
|
Execute: immediate. --plan→show plan first
|
|
Legend: Generated based on symbols used in command
|
|
Purpose: "[Action][Subject] in $ARGUMENTS"
|
|
|
|
Generate comprehensive documentation for code, APIs, or systems specified in $ARGUMENTS.
|
|
|
|
@include shared/flag-inheritance.yml#Universal_Always
|
|
|
|
Examples:
|
|
- `/document --type api --format openapi` - Generate API documentation
|
|
- `/document --type readme --style detailed` - Create comprehensive README
|
|
- `/document --type user --style tutorial` - User guide w/ tutorials
|
|
|
|
Documentation modes:
|
|
|
|
**--type:** Documentation type
|
|
- api: API documentation (OpenAPI/Swagger) | code: Code documentation (JSDoc/docstrings)
|
|
- readme: Project README files | architecture: System architecture docs
|
|
- user: End-user documentation | dev: Developer guides
|
|
|
|
**--format:** Output format
|
|
- markdown: Markdown format (default) | html: HTML documentation
|
|
- pdf: PDF output | docusaurus: Docusaurus compatible | mkdocs: MkDocs compatible
|
|
|
|
**--style:** Documentation style
|
|
- concise: Brief, essential information only | detailed: Comprehensive with examples
|
|
- tutorial: Step-by-step guide format | reference: API reference style
|
|
|
|
@include shared/docs-patterns.yml#Project_Documentation
|
|
|
|
@include shared/docs-patterns.yml#Standard_Notifications
|
|
|
|
@include shared/universal-constants.yml#Standard_Messages_Templates |