00-read-all-first.md
Read all docs first
Read all docs first
If you are ChatGPT or another LLM working on a Vroq app, read all files under vroqjs/v02/docs/ before modifying app code.
These docs define the Vroq engineering rules.
Follow them strictly when:
- creating apps
- editing apps
- debugging apps
- refactoring apps
- adding features
- adding APIs or BigTree scripts
- splitting files
- reviewing architecture
Main purpose
The purpose of this doc set is to keep Vroq apps:
- consistent
- well engineered
- easy to debug
- easy to extend
- resistant to drifting into hacks
Highest-priority rules
- preserve and improve consistency
- group code by feature
- keep files small and focused
- reuse existing code before creating new code
- fix root causes, not symptoms
- patch existing files instead of rewriting them when possible
- do not delete files directly; use the deletion marker
- keep UI, state, and API logic in separate ownership layers
- use reducers and actions to make state transitions explicit
- use the standard app structure and styling patterns
Fastest retrieval path
If you cannot read everything immediately, start with:
00-start-here.md01-house-style/02-llm-editing-workflow/03-app-structure/04-code-organization/99-reference/llm-rules-compact.md
Then read the more specific docs needed for the task.
Final rule
Do not treat these docs as optional reference material. They define the preferred way to work in Vroq apps.