This directory is the index for active Navet documentation. The goal of this index is to point to the docs that are meant to describe the current codebase rather than historical snapshots.
- ../README.md: project overview, setup, commands, testing workflow, and architecture summary
- technical/REACT_ZUSTAND.md: shared-state rules, store boundaries, and service-to-store flow
- STORYBOOK_WORKFLOW.md: Storybook taxonomy, story placement, fixture rules, and review checklist
- ../design-system/README.md: shared UI layers, Storybook workflow, and theme/token guidance
- ../design-system/FEATURES.md: current feature inventory, section ownership, and test/story coverage map
- WIDGETS.md: widget behavior and extension notes
- DOCKER_HOME_ASSISTANT_ADDON.md: Home Assistant custom panel, Docker, and add-on deployment
- VERSIONING.md: release numbering and bump policy
- ROADMAP.md: planned work and shipped history
- technical/REACT_ZUSTAND.md: Zustand-only shared state guidance
- STORYBOOK_WORKFLOW.md: Storybook workflow and story authoring guide
- PUBLIC_LAUNCH_SECURITY.md: security gates and deployment hardening for public releases
- ../design-system/README.md: UI-layer boundaries and Storybook-first workflow
- ../design-system/FEATURES.md: current product surface, section routing, and ownership map
- ../design-system/UI-GUIDELINES.md: visual rules, theme constraints, and performance-sensitive UI guidance
- branding/BRANDING.md: brand identity and usage
- branding/BRANDING_ASSETS.md: brand assets and references
- branding/TRADEMARK_POLICY.md: trademark usage policy
- TERMS_OF_USE.md: code-license and branding summary
- ATTRIBUTIONS.md: third-party attributions
- archive/CHANGES.md: archived migration and change history
Use these directories when docs need to be checked against the live implementation:
src/app/features/: feature-owned modulessrc/app/components/: shared UI layers and app-shell compositionsrc/app/ui-kit/: canonical shared UI import surface for docs, examples, and stable consumerssrc/app/stores/: Zustand stores and selectorssrc/app/services/: Home Assistant facade plus connection, entity, and registry servicessrc/app/storybook/: shared Storybook frames and docs helperssrc/test/: shared Vitest helpers, stubs, and browser mocks
- ../design-system/README.md
- ../design-system/UI-GUIDELINES.md
- STORYBOOK_WORKFLOW.md
- ../README.md for current command and review workflow
- technical/REACT_ZUSTAND.md
- ../design-system/FEATURES.md
- WIDGETS.md
../src/test/for test harness helpers
- ../README.md for current test commands and active
__tests__/directories ../src/test/for shared test utilities- technical/REACT_ZUSTAND.md for store/service behavior expectations
- Keep active docs aligned with the codebase when architecture, setup, commands, or product surface changes
- Prefer updating existing active docs over adding duplicate scratch notes
- Treat
docs/archive/as historical material, not the current source of truth - When top-level sections, shared stores, widget types, dashboard edit behavior, or test locations change, update
README.md,docs/WIDGETS.md, anddesign-system/FEATURES.md - When Storybook ownership, UI-layer boundaries, token helpers, or
ui-kit/exports change, updatedesign-system/README.mdandSTORYBOOK_WORKFLOW.md - When the Home Assistant service split or typed event flow changes, update
README.mdandtechnical/REACT_ZUSTAND.md - When setup scripts or test commands change, update
README.md
Last updated: May 21, 2026