Halo Development Context v3
Mandatory Entry (Read in Order)
CONTEXT.md — Product vision, development principles (styling, responsive, security, i18n), and current state.
ARCHITECTURE.md — Directory structure, data types, IPC channels, theme system, CSS rules, responsive design, layout modes, multi-platform, local storage, tech stack.
quick.md — Hard development rules (with code examples), task-to-file routing, and checklists.
Do not start implementation before reading these three files.
All code changes must comply with the patterns, conventions, and structures described in these documents. This includes:
- Responsive design (mobile-first,
sm: breakpoint at 640px)
- Theme system (CSS variables only, no hardcoded colors)
- Tailwind-first styling (no unnecessary CSS files)
- IPC channel synchronization (preload + transport + API)
- i18n (
t('English text') for all user-facing strings)
- Production logging
If a change conflicts with the documented architecture, update the architecture document first with justification, then proceed.
Development Priority (Non-Negotiable)
- Modularity, quality, and maintainability come first.
- Performance must not regress (startup, runtime latency, memory).
- Responsive design is mandatory — every UI change must work at mobile width (< 640px).
- No hardcoded colors — use only CSS variable-based theme tokens.
- If a quick fix conflicts with architecture quality, choose the maintainable modular solution and request explicit user approval before proceeding.
Fast Navigation Policy
After the mandatory entry docs:
- Jump directly to touched module
DESIGN.md:
src/main/apps/*/DESIGN.md
src/main/platform/*/DESIGN.md
- For transport-level changes, inspect:
src/main/ipc/
src/main/http/routes/index.ts
src/preload/index.ts
src/renderer/api/index.ts
- For renderer changes, check:
- Existing component structure in
src/renderer/components/
- Existing stores in
src/renderer/stores/
- Existing hooks in
src/renderer/hooks/
Source of Truth Priority
When docs and code differ:
- Actual code in
src/**
- Module design docs (
src/main/apps/*/DESIGN.md, src/main/platform/*/DESIGN.md)
quick.md, ARCHITECTURE.md, CONTEXT.md
Keeping These Documents Updated
After completing a development task, evaluate whether these documents need updating. Apply the following rules:
Update when the change significantly affects how a developer understands the codebase:
- New module or service added to the architecture
- New IPC channel introduced
- Major refactoring that changes code organization
- New architectural pattern or convention established
- Core data type added or significantly changed
- New component directory or page added
Do not update for changes that don't affect architectural understanding:
- Bug fixes
- Minor features within existing modules
- Styling or UI tweaks
- Performance optimizations that don't change structure
- Dependency updates
- Code cleanup or formatting
The threshold is: would a new AI developer make wrong assumptions without this information? If yes, update. If no, skip.
1---2name: halo-dev3description: important!!! Must read and follow before writing or editing any code, and equally before planning, designing, or discussing architecture for this codebase (module placement, directory layout, IPC channels, theme, i18n) — decisions made while planning are what the later edit is bound by. Entry point to CONTEXT.md / ARCHITECTURE.md / quick.md. Covers architecture, conventions, quality standards, and responsive design requirements.4---56# Halo Development Context v378## Mandatory Entry (Read in Order)9101. `CONTEXT.md` — Product vision, development principles (styling, responsive, security, i18n), and current state.112. `ARCHITECTURE.md` — Directory structure, data types, IPC channels, theme system, CSS rules, responsive design, layout modes, multi-platform, local storage, tech stack.123. `quick.md` — Hard development rules (with code examples), task-to-file routing, and checklists.1314**Do not start implementation before reading these three files.**1516All code changes **must** comply with the patterns, conventions, and structures described in these documents. This includes:17- Responsive design (mobile-first, `sm:` breakpoint at 640px)18- Theme system (CSS variables only, no hardcoded colors)19- Tailwind-first styling (no unnecessary CSS files)20- IPC channel synchronization (preload + transport + API)21- i18n (`t('English text')` for all user-facing strings)22- Production logging2324If a change conflicts with the documented architecture, update the architecture document first with justification, then proceed.2526## Development Priority (Non-Negotiable)2728- **Modularity, quality, and maintainability come first.**29- **Performance must not regress** (startup, runtime latency, memory).30- **Responsive design is mandatory** — every UI change must work at mobile width (< 640px).31- **No hardcoded colors** — use only CSS variable-based theme tokens.32- If a quick fix conflicts with architecture quality, choose the maintainable modular solution and request explicit user approval before proceeding.3334## Fast Navigation Policy3536After the mandatory entry docs:3738- Jump directly to touched module `DESIGN.md`:39 - `src/main/apps/*/DESIGN.md`40 - `src/main/platform/*/DESIGN.md`41- For transport-level changes, inspect:42 - `src/main/ipc/`43 - `src/main/http/routes/index.ts`44 - `src/preload/index.ts`45 - `src/renderer/api/index.ts`46- For renderer changes, check:47 - Existing component structure in `src/renderer/components/`48 - Existing stores in `src/renderer/stores/`49 - Existing hooks in `src/renderer/hooks/`5051## Source of Truth Priority5253When docs and code differ:54551. Actual code in `src/**`562. Module design docs (`src/main/apps/*/DESIGN.md`, `src/main/platform/*/DESIGN.md`)573. `quick.md`, `ARCHITECTURE.md`, `CONTEXT.md`5859## Keeping These Documents Updated6061After completing a development task, evaluate whether these documents need updating. Apply the following rules:6263**Update when** the change significantly affects how a developer understands the codebase:64- New module or service added to the architecture65- New IPC channel introduced66- Major refactoring that changes code organization67- New architectural pattern or convention established68- Core data type added or significantly changed69- New component directory or page added7071**Do not update** for changes that don't affect architectural understanding:72- Bug fixes73- Minor features within existing modules74- Styling or UI tweaks75- Performance optimizations that don't change structure76- Dependency updates77- Code cleanup or formatting7879The threshold is: **would a new AI developer make wrong assumptions without this information?** If yes, update. If no, skip.