vrr/CodeNomad
2
0
Fork 0
mirror of https://github.com/NeuralNomadsAI/CodeNomad.git synced 2026-08-21 14:23:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
CodeNomad/dev-docs/INDEX.md
Pascal André 07f29d08d5
feat(opencode): migrate CodeNomad to native V2 
Replace the V1 SDK, custom plugin, and per-workspace runtimes with the pinned OpenCode V2 client and one shared service. Model workspaces through native locations and route sessions, messages, events, files, VCS, permissions, questions, providers, commands, and MCP directly through V2 APIs.

Remove the legacy plugin and background-process layers, use native Shell and PTY support, preserve server-side Git mutations where V2 lacks parity, and update the UI, packaging, CI, architecture documentation, and translations for the new model.

Add focused coverage for shared-service ownership, Windows and WSL startup, proxy boundaries, worktree event routing, native event normalization, provider authentication, voice instructions, and location-scoped requests. Server and UI typechecks pass; remaining security review items and the real opencode2 smoke test are documented in MIGRATION_V2.md and will be completed before the draft PR is marked ready.
2026-08-12 20:09:44 +02:00

4.8 KiB
Raw Blame History

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/client integration
  • IPC communication
  • Error handling strategies

Read this to understand: Current implementation boundaries

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:

  1. SUMMARY.md - Get the big picture
  2. architecture.md - Understand the structure
  3. user-interface.md - See what you're building
  4. build-roadmap.md - Understand the plan
  5. tasks/README.md - Learn the workflow

For Implementers:

  1. tasks/README.md - Understand task workflow
  2. technical-implementation.md - Implementation patterns
  3. tasks/todo/001-*.md - Start with first task
  4. Refer to architecture.md and user-interface.md as needed

For Designers:

  1. user-interface.md - Complete UI specs
  2. architecture.md - Component structure
  3. SUMMARY.md - Feature overview

For Project Managers:

  1. SUMMARY.md - Executive overview
  2. build-roadmap.md - Timeline and phases
  3. 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:

  1. Update the relevant file
  2. Update "Last Updated" in this index
  3. Update SUMMARY.md if adding major changes
  4. Keep consistent formatting and style

This index will be updated as more documentation is added.