mirror of
https://github.com/NeuralNomadsAI/CodeNomad.git
synced 2026-08-24 07:43:28 +00:00
775c6c6ca1
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.
97 lines
2.4 KiB
Markdown
97 lines
2.4 KiB
Markdown
# Documentation Index
|
|
|
|
Quick reference to all documentation files.
|
|
|
|
## Main Documents
|
|
|
|
### [README.md](../README.md)
|
|
|
|
Project overview, installation, and getting started guide.
|
|
|
|
### [SUMMARY.md](SUMMARY.md)
|
|
|
|
Executive summary of the entire project - **start here!**
|
|
|
|
### [MVP-PRINCIPLES.md](MVP-PRINCIPLES.md)
|
|
|
|
**MVP development philosophy** - Focus on functionality, NOT performance ⚡
|
|
|
|
---
|
|
|
|
## Specification Documents
|
|
|
|
### [architecture.md](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](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](technical-implementation.md)
|
|
|
|
**Implementation details**
|
|
|
|
- File structure
|
|
- TypeScript interfaces
|
|
- Shared OpenCode service and location ownership
|
|
- Native `@opencode-ai/client` integration
|
|
- IPC communication
|
|
- Error handling strategies
|
|
|
|
**Read this to understand:** Current implementation boundaries
|
|
|
|
---
|
|
|
|
## Reading Order
|
|
|
|
### For First-Time Readers:
|
|
|
|
1. [SUMMARY.md](SUMMARY.md) - Get the big picture
|
|
2. [architecture.md](architecture.md) - Understand the structure
|
|
3. [user-interface.md](user-interface.md) - See what you're building
|
|
|
|
### For Implementers:
|
|
|
|
1. [technical-implementation.md](technical-implementation.md) - Implementation patterns
|
|
2. Refer to architecture.md and user-interface.md as needed
|
|
|
|
### For Designers:
|
|
|
|
1. [user-interface.md](user-interface.md) - Complete UI specs
|
|
2. [architecture.md](architecture.md) - Component structure
|
|
3. [SUMMARY.md](SUMMARY.md) - Feature overview
|
|
|
|
---
|
|
|
|
## Quick Reference
|
|
|
|
### Common Questions
|
|
|
|
**Q: Where do I start?**
|
|
A: Read [SUMMARY.md](SUMMARY.md), then [architecture.md](architecture.md) and [technical-implementation.md](technical-implementation.md).
|
|
|
|
**Q: What does the UI look like?**
|
|
A: See [user-interface.md](user-interface.md) for complete specifications
|
|
|
|
**Q: How does it work internally?**
|
|
A: See [architecture.md](architecture.md) for system design
|
|
|
|
**Q: How do I build feature X?**
|
|
A: See [technical-implementation.md](technical-implementation.md) for patterns
|