Delete the obsolete pre-MVP roadmap and task references now that Git preserves that development history, while retaining current V2 operational and architecture guidance. Remove behavior-neutral server and UI plumbing that has no remaining caller: unused workspace options and cached endpoint state, redundant auto-accept metadata, an unused PTY get adapter, and a one-use message-loading helper. Keep lifecycle proof, restore gates, timeline projection, and targeted invalidation because they still enforce runtime behavior. Validated with server and UI typechecks, the full server suite (308 passed, 3 skipped), focused UI matrices, browser-conditioned UI tests, production server/UI build, diff checks, caller searches, and an independent regression review.
2.4 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
- Shared OpenCode service and location ownership
- Native
@opencode-ai/clientintegration - IPC communication
- Error handling strategies
Read this to understand: Current implementation boundaries
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
For Implementers:
- technical-implementation.md - Implementation patterns
- 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
Quick Reference
Common Questions
Q: Where do I start?
A: Read SUMMARY.md, then architecture.md and technical-implementation.md.
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