4.8 KiB
Documentation Index
Quick reference to all documentation files.
Main Documents
README.md
Project overview, installation, and getting started guide.
SUMMARY.md
Executive summary of the entire project - start here!
MVP-PRINCIPLES.md
MVP development philosophy - Focus on functionality, NOT performance ⚡
Specification Documents
architecture.md
Complete system architecture
- Component layers and responsibilities
- State management structure
- Data flow diagrams
- Technology stack
- Security and performance considerations
Read this to understand: How the app is structured
user-interface.md
Complete UI/UX specifications
- Every screen and component layout
- Visual design specifications
- Interaction patterns
- Accessibility requirements
- Color schemes and typography
Read this to understand: What the app looks like and how users interact
technical-implementation.md
Implementation details
- File structure
- TypeScript interfaces
- Process management logic
- SDK integration patterns
- IPC communication
- Error handling strategies
Read this to understand: How to actually build it
build-roadmap.md
Development plan
- 8 phases of development
- Task dependencies
- Timeline estimates
- Success criteria
- Risk mitigation
Read this to understand: The development journey from start to finish
Task Documents
tasks/README.md
Task management guide
- Task workflow
- Naming conventions
- How to work on tasks
- Progress tracking
Task Files (in tasks/todo/)
- 001-project-setup.md - Electron + SolidJS boilerplate
- 002-empty-state-ui.md - Initial UI with folder selection
- 003-process-manager.md - OpenCode server spawning
- 004-sdk-integration.md - API client integration
- 005-session-picker-modal.md - Session selection UI
More tasks will be added as we progress through phases.
Reading Order
For First-Time Readers:
- SUMMARY.md - Get the big picture
- architecture.md - Understand the structure
- user-interface.md - See what you're building
- build-roadmap.md - Understand the plan
- tasks/README.md - Learn the workflow
For Implementers:
- tasks/README.md - Understand task workflow
- technical-implementation.md - Implementation patterns
- tasks/todo/001-*.md - Start with first task
- Refer to architecture.md and user-interface.md as needed
For Designers:
- user-interface.md - Complete UI specs
- architecture.md - Component structure
- SUMMARY.md - Feature overview
For Project Managers:
- SUMMARY.md - Executive overview
- build-roadmap.md - Timeline and phases
- tasks/README.md - Task tracking
Quick Reference
Common Questions
Q: Where do I start?
A: Read SUMMARY.md, then start Task 001
Q: How long will this take?
A: See build-roadmap.md - MVP in 3-7 weeks depending on commitment
Q: What does the UI look like?
A: See user-interface.md for complete specifications
Q: How does it work internally?
A: See architecture.md for system design
Q: How do I build feature X?
A: See technical-implementation.md for patterns
Q: What's the development plan?
A: See build-roadmap.md for phases
Document Status
| Document | Status | Last Updated |
|---|---|---|
| README.md | ✅ Complete | 2024-10-22 |
| SUMMARY.md | ✅ Complete | 2024-10-22 |
| architecture.md | ✅ Complete | 2024-10-22 |
| user-interface.md | ✅ Complete | 2024-10-22 |
| technical-implementation.md | ✅ Complete | 2024-10-22 |
| build-roadmap.md | ✅ Complete | 2024-10-22 |
| tasks/README.md | ✅ Complete | 2024-10-22 |
| Task 001-005 | ✅ Complete | 2024-10-22 |
Project phase: Post-MVP (Phases 1-3 complete; Phase 4 work underway).
Contributing to Documentation
When updating documentation:
- Update the relevant file
- Update "Last Updated" in this index
- Update SUMMARY.md if adding major changes
- Keep consistent formatting and style
This index will be updated as more documentation is added.