Docs
VroqJS v02 documentation
These pages are rendered from Markdown files in the configured VroqJS v02 source docs/ directory.
Documentation pages
- Read all docs first
00-read-all-first.md - Start here
00-start-here.md - House style overview
01-house-style/00-overview.md - Core principles
01-house-style/01-core-principles.md - Naming conventions
01-house-style/02-naming.md - Directory structure
01-house-style/03-directory-structure.md - Small files
01-house-style/05-small-files.md - Reuse over rewrite
01-house-style/06-reuse-over-rewrite.md - Real fixes, not hacks
01-house-style/07-real-fixes-not-hacks.md - LLM editing workflow overview
02-llm-editing-workflow/00-overview.md - How ChatGPT should read an app
02-llm-editing-workflow/01-how-chatgpt-should-read-an-app.md - How ChatGPT should edit an app
02-llm-editing-workflow/02-how-chatgpt-should-edit-an-app.md - How ChatGPT should debug an app
02-llm-editing-workflow/03-how-chatgpt-should-debug-an-app.md - How ChatGPT should refactor an app
02-llm-editing-workflow/04-how-chatgpt-should-refactor-an-app.md - Vroq MCP rules
02-llm-editing-workflow/05-vroq-mcp-rules.md - Patching vs rewriting
02-llm-editing-workflow/06-patching-vs-rewriting.md - Deletion policy
02-llm-editing-workflow/07-deletion-policy.md - How ChatGPT should debug using Vroq MCP
02-llm-editing-workflow/08-how-chatgpt-should-debug-using-vroq-mcp.md - App structure overview
03-app-structure/00-overview.md - Bootstrap
03-app-structure/01-bootstrap.md - index.html
03-app-structure/02-index-html.md - App.js
03-app-structure/03-app-js.md - Feature folders
03-app-structure/04-feature-folders.md - Shared code
03-app-structure/05-shared-code.md - Store setup
03-app-structure/06-store-setup.md - initialState.js
03-app-structure/07-initial-state.md - Components vs Features vs Sections
03-app-structure/08-components-vs-features-vs-sections.md - When to create a new file
03-app-structure/09-when-to-create-a-new-file.md - Code organization overview
04-code-organization/00-overview.md - Components
04-code-organization/01-components.md - Features
04-code-organization/02-features.md - Sections
04-code-organization/03-sections.md - Reusable sections with paths
04-code-organization/04-reusable-sections-with-paths.md - Actions
04-code-organization/05-actions.md - Reducers
04-code-organization/06-reducers.md - API clients
04-code-organization/07-api-clients.md - UI files
04-code-organization/08-ui-files.md - Splitting large files
04-code-organization/09-splitting-large-files.md - Styling overview
05-styling/00-overview.md - ui.css and bootstrap styling
05-styling/01-ui-css-and-bootstrap.md - Theme tokens
05-styling/02-theme-tokens.md - Layout patterns
05-styling/03-layout-patterns.md - Component styling
05-styling/04-component-styling.md - Inline style vs CSS
05-styling/05-inline-style-vs-css.md - Consistent app visual structure
05-styling/06-consistent-app-visual-structure.md - BigTree and API design overview
06-big-tree-and-apis/00-overview.md - API design principles
06-big-tree-and-apis/01-api-design-principles.md - When to write a script
06-big-tree-and-apis/02-when-to-write-a-script.md - How to write a script
06-big-tree-and-apis/03-how-to-write-a-script.md - How apps call scripts
06-big-tree-and-apis/04-how-apps-call-scripts.md - RPC design
06-big-tree-and-apis/05-rpc-design.md - Error shapes
06-big-tree-and-apis/06-error-shapes.md - Debuggable API design
06-big-tree-and-apis/07-debuggable-api-design.md - Debuggable state overview
07-debuggable-state/00-overview.md - Why reducers matter
07-debuggable-state/01-why-reducers-matter.md - Action design
07-debuggable-state/02-action-design.md - Reducer boundaries
07-debuggable-state/03-reducer-boundaries.md - State shape
07-debuggable-state/04-state-shape.md - Debugging with actions and reducers
07-debuggable-state/05-debugging-with-actions-and-reducers.md - Logging, checkpoints, and replay
07-debuggable-state/06-logging-checkpoints-replay.md - Recipes overview
08-recipes/00-overview.md - Create a new app
08-recipes/01-create-a-new-app.md - Add a component
08-recipes/02-add-a-component.md - Add a feature
08-recipes/03-add-a-feature.md - Add a section
08-recipes/04-add-a-section.md - Add a BigTree API
08-recipes/05-add-a-bigtree-api.md - Fix a bug
08-recipes/06-fix-a-bug.md - Refactor a large file
08-recipes/07-refactor-a-large-file.md - Make code more reusable
08-recipes/08-make-code-more-reusable.md - Split a feature cleanly
08-recipes/09-split-a-feature-cleanly.md - App review checklist
99-reference/app-review-checklist.md - Component API conventions
99-reference/component-api-conventions.md - Component vocabulary
99-reference/component-vocabulary.md - File templates
99-reference/file-templates.md - Finding framework files
99-reference/finding-framework-files.md - Framework imports
99-reference/framework-imports.md - LLM rules compact
99-reference/llm-rules-compact.md - Naming cheatsheet
99-reference/naming-cheatsheet.md - v02 component migration plan
99-reference/v02-component-migration-plan.md