forked from automazeio/ccpm
-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
epic:vscode-extensionTasks for vscode-extensionTasks for vscode-extensiontaskIndividual taskIndividual task
Description
Task: Create README with installation, usage, and screenshots
Description
Create a comprehensive README.md file for the VSCode extension that includes installation instructions, usage guide, feature documentation, and screenshots. The README should serve as the primary documentation for users and appear on the VSCode marketplace.
Acceptance Criteria
- README includes clear installation instructions (marketplace and manual)
- Usage guide covers all major features with examples
- Screenshots demonstrate key features (tree view, progress panel, commands)
- Configuration options documented with examples
- Troubleshooting section included
- Links to full documentation and support channels
- Badges for version, downloads, and rating
- Professional formatting with proper markdown structure
Technical Details
- Create
extensions/vscode/README.md - Include sections:
- Overview and features
- Installation (from marketplace and VSIX)
- Quick start guide
- Feature documentation with screenshots
- Configuration options
- Commands and keybindings
- Troubleshooting and FAQ
- Contributing guidelines
- License information
- Capture screenshots showing:
- Epic/Task tree view with different states
- Progress panel with metrics
- Command palette commands
- Settings UI
- Status bar integration
- Use relative image paths for marketplace compatibility
- Follow VSCode extension README best practices
- Files affected:
extensions/vscode/README.md(new file)
Dependencies
- Task 2: Extension scaffolding complete
- Task 10: Epic data provider (for feature screenshots)
- Task 20: Tree view implementation (for screenshots)
- Task 30: Progress panel (for screenshots)
- Task 40: Command implementations (for documentation)
- Task 63: Demo GIFs available for embedding
Effort Estimate
- Size: M
- Hours: 8
- Parallel: false
Definition of Done
- Code implemented
- Tests written and passing
- Documentation updated
- Code reviewed
Metadata
Metadata
Assignees
Labels
epic:vscode-extensionTasks for vscode-extensionTasks for vscode-extensiontaskIndividual taskIndividual task