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,99 +1,226 @@
|
||||
@include shared/constants.yml#Process_Symbols
|
||||
# /document - Generate comprehensive documentation
|
||||
|
||||
@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 | | |
|
||||
|
||||
Create comprehensive docs for code, API, or system specified in $ARGUMENTS.
|
||||
## Purpose
|
||||
Generate comprehensive documentation for code, APIs, or systems specified in $ARGUMENTS with various output formats and styles.
|
||||
|
||||
Flags:
|
||||
- --api: Generate API docs | --user: Generate user-friendly guides
|
||||
- --ultracompressed, --uc: Generate docs w/ ~70% fewer tokens using telegram-style
|
||||
## Syntax
|
||||
`/document [flags] [target]`
|
||||
|
||||
--api flag:
|
||||
- Document all endpoints w/ examples | Include request/response formats
|
||||
- Specify auth requirements | Document error codes & meanings | Add rate limiting info | Provide code samples→multiple languages
|
||||
## 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"
|
||||
|
||||
--user flag:
|
||||
- Create user-friendly guides | Include step-by-step tutorials | Add screenshots or diagrams
|
||||
- Write FAQ section | Include troubleshooting guide | Provide real-world examples
|
||||
## Command-Specific Flags
|
||||
|
||||
Documentation types:
|
||||
**Documentation Types:**
|
||||
- `--api`: Generate API documentation with endpoints, schemas, examples
|
||||
- `--user`: Create user-friendly guides with tutorials and walkthroughs
|
||||
- `--architecture`: System design documentation with diagrams
|
||||
- `--developer`: Developer guides with setup and implementation details
|
||||
- `--readme`: Project README with overview and quick start
|
||||
|
||||
README Documentation:
|
||||
**Output Format:**
|
||||
- `--visual`: Include diagrams, flowcharts, and visual aids
|
||||
- `--examples`: Generate practical code examples and snippets
|
||||
- `--interactive`: Create interactive documentation with live examples
|
||||
|
||||
**Content Depth:**
|
||||
- `--depth`: Explanation depth (basic|intermediate|advanced|expert)
|
||||
- `--complete`: Comprehensive documentation covering all aspects
|
||||
- `--quick`: Essential documentation for rapid reference
|
||||
|
||||
## Documentation Types
|
||||
|
||||
**README Documentation:**
|
||||
- Project overview and purpose
|
||||
- Installation instructions
|
||||
- Quick start guide
|
||||
- Configuration options
|
||||
- Installation instructions and requirements
|
||||
- Quick start guide with examples
|
||||
- Configuration options and environment setup
|
||||
- Basic usage examples
|
||||
- Contributing guidelines
|
||||
- Contributing guidelines and standards
|
||||
|
||||
Architecture Documentation:
|
||||
- System design overview
|
||||
- Component relationships
|
||||
- Data flow diagrams
|
||||
- Technology choices rationale
|
||||
- Scalability considerations
|
||||
- Security architecture
|
||||
|
||||
API Documentation:
|
||||
- Endpoint descriptions
|
||||
**API Documentation:**
|
||||
- Complete endpoint descriptions
|
||||
- HTTP methods and status codes
|
||||
- Request/response schemas
|
||||
- Authentication methods
|
||||
- Example requests with curl/code
|
||||
- Webhook documentation
|
||||
- WebSocket events (if applicable)
|
||||
- Request/response schemas with validation
|
||||
- Authentication and authorization methods
|
||||
- Rate limiting and quota information
|
||||
- Code examples in multiple languages
|
||||
- Error handling and troubleshooting
|
||||
|
||||
User Guides:
|
||||
- Getting started tutorial
|
||||
- Feature walkthroughs
|
||||
- Best practices guide
|
||||
- Common use cases
|
||||
- Integration guides
|
||||
- Migration guides
|
||||
**Architecture Documentation:**
|
||||
- System design overview and principles
|
||||
- Component relationships and dependencies
|
||||
- Data flow diagrams and sequence charts
|
||||
- Technology choices and rationale
|
||||
- Scalability considerations and patterns
|
||||
- Security architecture and threat model
|
||||
|
||||
Developer Documentation:
|
||||
- Code structure overview
|
||||
- Development setup
|
||||
- Testing guidelines
|
||||
- Deployment process
|
||||
- Debugging tips
|
||||
- Performance optimization
|
||||
**User Guides:**
|
||||
- Getting started tutorials
|
||||
- Feature walkthroughs with screenshots
|
||||
- Best practices and common patterns
|
||||
- Integration guides and examples
|
||||
- Migration guides and upgrade paths
|
||||
- FAQ and troubleshooting sections
|
||||
|
||||
Documentation standards:
|
||||
- Use clear, concise language
|
||||
- Include practical examples
|
||||
**Developer Documentation:**
|
||||
- Codebase structure and organization
|
||||
- Development environment setup
|
||||
- Testing guidelines and frameworks
|
||||
- Deployment processes and CI/CD
|
||||
- Debugging tips and tools
|
||||
- Performance optimization techniques
|
||||
|
||||
## Examples
|
||||
- `/document --api --examples --c7` → API docs with framework examples
|
||||
- `/document --user --visual --interactive` → Interactive user guides
|
||||
- `/document --architecture --complete --seq` → Comprehensive system docs
|
||||
- `/document --developer --depth advanced` → Advanced developer guides
|
||||
- `/document --readme --quick --uc` → Concise project README
|
||||
|
||||
## Documentation Standards
|
||||
|
||||
**Content Quality:**
|
||||
- Use clear, concise language appropriate for audience
|
||||
- Include practical, tested examples
|
||||
- Add visual aids where helpful
|
||||
- Keep information current
|
||||
- Make it searchable
|
||||
- Version-specific when needed
|
||||
- Keep information current and accurate
|
||||
- Make content searchable and navigable
|
||||
- Version documentation with code changes
|
||||
|
||||
**Structure Guidelines:**
|
||||
- Logical organization with clear hierarchy
|
||||
- Progressive disclosure of complexity
|
||||
- Cross-references between related topics
|
||||
- Glossary for technical terms
|
||||
- Index for quick reference
|
||||
- Changelog maintenance
|
||||
|
||||
**UltraCompressed Mode (--uc):**
|
||||
- Apply token reduction rules (~70% savings)
|
||||
- Generate symbol/abbreviation legend
|
||||
- Use telegram-style formatting
|
||||
- Structure: YAML > tables > lists > prose
|
||||
- Compress headers and sentences
|
||||
- Focus on essential information only
|
||||
|
||||
## Deliverables
|
||||
- **Documentation Files**: Complete docs in specified format
|
||||
- **Code Examples**: Working, tested code snippets
|
||||
- **Visual Aids**: Diagrams, charts, and illustrations
|
||||
- **Index Files**: Navigation and cross-reference guides
|
||||
- **Templates**: Reusable documentation templates
|
||||
|
||||
## Output Locations
|
||||
- **API Documentation**: `docs/api/`
|
||||
- **User Guides**: `docs/guides/`
|
||||
- **Architecture Docs**: `docs/architecture/`
|
||||
- **Developer Docs**: `docs/development/`
|
||||
- **README Files**: Project root and subdirectories
|
||||
- **Index**: `docs/index.md` with navigation links
|
||||
|
||||
## 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
|
||||
|
||||
## Integration & Best Practices
|
||||
|
||||
**Quality Assurance:**
|
||||
- Test all code examples
|
||||
- Verify links and references
|
||||
- Review for clarity and accuracy
|
||||
- Validate against actual implementation
|
||||
|
||||
When --ultracompressed flag is present:
|
||||
- Apply shared/ultracompressed.yml rules
|
||||
- Generate legend at doc start
|
||||
- Remove articles, conjunctions, fillers
|
||||
- Use symbols: →&@+- w/ w/o
|
||||
- Use abbreviations: cfg fn impl req resp
|
||||
- Headings <20 chars, sentences <50 chars
|
||||
- Format: YAML>JSON>prose, tables>lists>paragraphs
|
||||
- Target ~70% token reduction
|
||||
**Maintenance Strategy:**
|
||||
- Update with code changes
|
||||
- Regular review and refresh
|
||||
- User feedback integration
|
||||
- Version control alignment
|
||||
|
||||
Structure guidelines:
|
||||
- Logical organization
|
||||
- Progressive disclosure
|
||||
- Cross-references
|
||||
- Glossary for terms
|
||||
- Index for quick lookup
|
||||
- Change log maintenance
|
||||
## Troubleshooting
|
||||
- **Large Codebases**: Use `--depth` to control scope
|
||||
- **Complex APIs**: Combine `--api --examples --c7` for comprehensive docs
|
||||
- **Technical Concepts**: Use `--visual --examples` for clarity
|
||||
- **Token Limits**: Apply `--uc` for compressed documentation
|
||||
|
||||
Documentation Output:
|
||||
- API documentation: `/docs/api/`
|
||||
- User guides: `/docs/guides/`
|
||||
- Architecture docs: `/docs/architecture/`
|
||||
- Developer docs: `/docs/development/`
|
||||
- README files: `/docs/README.md` (main), subdirectory READMEs as needed
|
||||
- Ensure directory exists: `mkdir -p /docs/[category]/`
|
||||
- Include location in output: "📚 Documentation created: [path]"
|
||||
- Update `/docs/index.md` with new documentation links
|
||||
|
||||
Deliverables: Complete documentation matching the specified type, working code examples, visual aids or diagrams as needed, and quick reference guide.
|
||||
## Success Messages
|
||||
✅ {operation} completed successfully
|
||||
📝 Created: {file_path}
|
||||
✏ Updated: {file_path}
|
||||
✨ Task completed: {task_title}
|
||||
|
||||
Reference in New Issue
Block a user