generated from Paul.Kim/tpl-superclaude
Initial commit
This commit is contained in:
33
.claude/commands/sc/index.md
Normal file
33
.claude/commands/sc/index.md
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
allowed-tools: [Read, Grep, Glob, Bash, Write]
|
||||
description: "Generate comprehensive project documentation and knowledge base"
|
||||
---
|
||||
|
||||
# /sc:index - Project Documentation
|
||||
|
||||
## Purpose
|
||||
Create and maintain comprehensive project documentation, indexes, and knowledge bases.
|
||||
|
||||
## Usage
|
||||
```
|
||||
/sc:index [target] [--type docs|api|structure|readme] [--format md|json|yaml]
|
||||
```
|
||||
|
||||
## Arguments
|
||||
- `target` - Project directory or specific component to document
|
||||
- `--type` - Documentation type (docs, api, structure, readme)
|
||||
- `--format` - Output format (md, json, yaml)
|
||||
- `--update` - Update existing documentation
|
||||
|
||||
## Execution
|
||||
1. Analyze project structure and identify key components
|
||||
2. Extract documentation from code comments and README files
|
||||
3. Generate comprehensive documentation based on type
|
||||
4. Create navigation structure and cross-references
|
||||
5. Output formatted documentation with proper organization
|
||||
|
||||
## Claude Code Integration
|
||||
- Uses Glob for systematic file discovery
|
||||
- Leverages Grep for extracting documentation patterns
|
||||
- Applies Write for creating structured documentation
|
||||
- Maintains consistency with project conventions
|
||||
Reference in New Issue
Block a user