mirror of
https://github.com/NeuralNomadsAI/CodeNomad.git
synced 2026-07-10 00:14:27 +00:00
## Summary
Add comprehensive architecture and SDK navigation skill to help
contributors navigate the codebase without missing related code.
## What's Included
- **Architecture Overview** — 6 functional areas (UserInterface,
ServerBackend, DesktopClient, SpeechAndAudio, BuildAndPackaging,
CloudflareDeployment), package map, and key entry points
- **UI Conventions** — SolidJS patterns, i18n system (7 locales),
signal-based stores, component styling
- **Server Conventions** — Fastify route patterns, API types,
configuration, testing approach
- **Desktop Conventions** — Electron + Tauri parity rules, native API
abstractions
- **SDK API Reference** — All 10 OpenCode SDK V2 categories used by
CodeNomad with signatures and wrapper locations
- **SDK Critical Behaviors** — Schema gotchas (assistant part metadata,
ignored flag asymmetry), decision matrix, race conditions
- **SDK Integration Patterns** — Client lifecycle, worktree routing,
error handling, optimistic updates
- **Feature Traces** — 5 end-to-end flows with decision branches:
permissions, sessions, speech, background processes, git clone
- **Anti-Patterns** — Common mistakes with file references to correct
implementations
- **Implementation Checklist** — Actionable steps before submitting
changes
## Design Decisions
- All navigation guidance uses standard grep/file search tools (no RPG
MCP server required)
- Split into 8 reference files to stay under 300 lines each
- File references included for every anti-pattern and convention
- Decision branches in feature traces (not just linear flows)
- Weighted quick start by contribution frequency
## Files Added
`
.opencode/skills/codenomad-architecture-guide/
├── SKILL.md
└── references/
├── architecture-overview.md
├── ui-conventions.md
├── server-conventions.md
├── desktop-conventions.md
├── sdk-api-reference.md
├── sdk-critical-behaviors.md
├── sdk-integration-patterns.md
└── feature-traces.md
`
|
||
|---|---|---|
| .. | ||
| agent | ||
| commands | ||
| skills/codenomad-architecture-guide | ||
| opencode.jsonc | ||
| package-lock.json | ||