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
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
Effort Estimate
- Size: M
- Hours: 8
- Parallel: false
Definition of Done
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
Technical Details
extensions/vscode/README.mdextensions/vscode/README.md(new file)Dependencies
Effort Estimate
Definition of Done