mirror of
https://github.com/NeuralNomadsAI/CodeNomad.git
synced 2026-08-25 00:03:44 +00:00
ab9b8572b5
Document the reviewed CodeNomad and OpenCode Desktop V2 baselines, incremental methodology, existing parity, and every defect closed by the accompanying implementation changes. Separate remaining work into active-location correctness, undo/redo, release signing, coordinated runtime upgrade, and optional PTY, export, reference, and MCP-resource features. Record rejected false positives and the validated Ponytail reduction. Link the comparison from the migration guide and documentation index so future V2 upgrades can resume from an explicit commit baseline instead of repeating the full audit.
101 lines
2.7 KiB
Markdown
101 lines
2.7 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 ⚡
|
|
|
|
### [DESKTOP_V2_COMPARISON.md](../DESKTOP_V2_COMPARISON.md)
|
|
|
|
Incremental comparison with official OpenCode Desktop V2, including parity, closed defects, remaining correctness work, runtime upgrade scope, and optional feature gaps.
|
|
|
|
---
|
|
|
|
## 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
|