Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

Version: 1.1.0 Last Updated: 2026-04-11 Status: Active Index of development guides, setup, and conventions for the Encore Health OS Platform.

​
Quick Start

New to the project? Start here:
  1. SETUP_QUICK_START.md ⭐ First-Time Setup
    • Environment variables checklist
    • PWA setup verification
    • CodeRabbit setup
    • First-time developer onboarding
  2. DEVELOPMENT_QUICK_REFERENCE.md ⭐ Daily Reference
    • Common commands (CodeRabbit, build, test)
    • Common patterns (spacing, colors, icons)
    • Common components (PageContainer, ResponsiveFormLayout)
    • Common gotchas (React.lazy, loading states, permissions)

​
Common Tasks

​
Setup & Configuration

​
Code Review Workflow

​
Security & dependencies

  • DEPENDENCY_SECURITY.md - npm audit, lockfile workflow, overrides, Deno npm: review cadence (not covered by npm audit), Dependabot

​
CI & quality gates

​
Spacing & Layout

​
Icons & Colors

Start Here: Constitution §6.3 (current: see docs/VERSIONS.md) defines the core navigation requirements. Component Documentation: src/platform/navigation/README.md

​
Setup & Configuration

​
PWA & Mobile Setup

  • PWA Setup ⭐ Start Here
    • Complete PWA configuration guide
    • Icon generation and setup
    • Service worker configuration
    • Performance optimization
    • Mobile safe area support
    • Testing checklist
  • Mobile Navigation Guide
    • Mobile navigation architecture
    • Bottom navigation bar implementation
    • Mobile menu patterns
    • Safe area insets guide
    • Touch target guidelines
    • Accessibility requirements
    • Navigation review findings
    • Dashboard standards integration
    • Quick actions pattern

​
Development Tools

  • CodeRabbit Guide ⭐ Complete Reference
    • Setup and installation
    • Configuration details
    • CLI commands and output modes
    • Workflow patterns (CodeRabbit + Lovable)
    • Reporting guide
    • Best practices
    • Troubleshooting
  • CODERABBIT_CURSOR_REVIEW_CONTEXT.md — CodeRabbit-oriented PR review context for Cursor. For CodeRabbit setup and YAML, use CodeRabbit Guide above.
  • CODE_REVIEW_PROCESS.md ⭐ Review Workflow
    • Quick start workflow
    • Daily commands reference
    • Pattern identification
    • Documentation update process

​
Environment & Configuration

​
Supabase (hub)

All Supabase-related setup, CLI, and troubleshooting in one place. For required variables, see ENVIRONMENT_VARIABLES.md and integrations/SUPABASE_SETUP.md.
DocPurpose
SUPABASE_SETUPProduction Supabase configuration, project setup
SUPABASE_MULTI_ENV_SETUP.mdLocal, staging, production env config
SUPABASE_CLI_LOCAL_WORKFLOW.mdMigrations, supabase start, db reset, link
Troubleshooting GuideFix “Remote migration versions not found”
MCP Usage GuideWhen to use Supabase MCP vs CLI
SUPABASE_AUTH_401_TROUBLESHOOTING.md401 auth errors and fixes
See also supabase/README.md for a short index in this tree.

​
Lovable workflow

  • Lovable docs — LOVABLE_CUSTOM_KNOWLEDGE, LOVABLE_PROMPTS, LOVABLE_REFERENCE_APPENDIX. Copy Custom Knowledge into Lovable; use prompts for the 4-chat workflow.
  • Lovable handoff guidance is consolidated in AGENTS.md and docs/tools/lovable/index.md.

​
Patterns & Standards

​
UI/UX Standards

  • UI/UX Standards ⭐ Canonical Standards
    • Complete UI/UX patterns and requirements
    • Design system tokens and usage
    • Page templates and required states
    • Navigation and information architecture
    • Mobile-first requirements
    • Performance UX patterns
    • Accessibility standards
  • UI Consistency Review — Spec/PR checklist for dialogs, PageContainer, skeletons, EmptyState, semantic tokens
  • Spec Command Cheat Sheet — Tiered map of Cursor spec commands (whats-next, validate, review, tasks, complete)
  • Navigation Guide Index ⭐ Start Here
    • Central index for all navigation documentation
    • Quick navigation by topic
    • Common use cases and workflows
    • Links to all navigation guides

​
UI Patterns

  • Icon Style Guide
    • Icon design guidelines
    • Icon usage patterns
    • Icon generation process
  • SPACING_AND_UX_STANDARDS.md ⭐ Complete Guide
    • Quick reference section at top
    • Spacing and layout patterns
    • Responsive spacing guidelines
    • Safe area considerations
    • Page container patterns
    • Grid and form spacing
  • Settings Pattern Guide
    • Settings page implementation
    • Module settings pattern
    • Organization-level settings
    • Upsert pattern and compliance status
Note: settings-page-pattern.md has been consolidated into settings-pattern-guide.md and archived.

​
Component Development

  • Storybook/Chromatic are currently deferred in this repository. See root CLAUDE.md for current status.

​
Migration & Adoption

  • Use module specs and specs/_templates/ checklists for migration/adoption tracking.

​
Development Guides

​
Core Development Guides

  • TROUBLESHOOTING_GUIDE.md ⭐ Problem Solving
    • Diagnostic workflow for common issues
    • Build & dependency troubleshooting
    • TypeScript errors
    • Supabase connection issues
    • Authentication problems
    • Performance debugging
    • Mobile-specific issues
    • Cross-browser compatibility
    • Quick reference table
  • DATABASE_DEVELOPMENT_GUIDE.md ⭐ Database Development
    • Multi-tenant architecture & RLS
    • RLS policy patterns
    • Migration creation and testing
    • Custom fields implementation
    • Multi-tenant query patterns
    • Database debugging
    • Code examples and best practices
  • TESTING_SETUP_AND_RUN.md ⭐ Testing
    • Canonical test execution runbook
    • Unit, integration, RLS, baseline, and E2E guidance
    • Environment variables and CI notes
  • API_DEVELOPMENT_GUIDE.md ⭐ API Development
    • API patterns (PostgREST, Edge Functions)
    • Creating API endpoints
    • Authentication & authorization
    • Error handling
    • Response formatting
    • API testing strategies
  • PERFORMANCE_OPTIMIZATION_GUIDE.md ⭐ Performance
    • Performance debugging workflow
    • Bundle size optimization
    • Query optimization
    • Image optimization
    • Lazy loading patterns
    • Caching strategies
    • Performance targets & metrics
Note: Module-specific documentation has been moved to appropriate locations:
  • FW module tables → docs/fw/module-tables.md
  • PF adoption tracker → specs/pf/adoption-tracker.md
  • Permissions V2 migration → specs/pf/permissions-v2-migration.md
  • Permissions V2 rollout → specs/pf/permissions-v2-rollout.md

​
Scripts & Utilities

​
Documentation Structure

​
File Organization

  • Setup Guides: *-SETUP.md or *-setup.md
  • Pattern Guides: *-pattern.md or *-PATTERN.md
  • Quick References: *-quick-reference.md or *-QUICK_REFERENCE.md
  • Style Guides: *-STYLE_GUIDE.md or *-style-guide.md
  • Checklists: *-CHECKLIST.md or *-checklist.md
Architecture: Module Guides: Platform Foundation:

​
See Also

Architecture Documentation: Standards & Patterns: Platform Foundation:

​
Quick Start Workflow

New developers: README, Architecture, then SETUP_QUICK_START.md. Patterns: DEVELOPMENT_QUICK_REFERENCE.md, UI_UX_STANDARDS.md, SPACING_AND_UX_STANDARDS.md. Daily: DEVELOPMENT_QUICK_REFERENCE.md, CODE_REVIEW_PROCESS.md. Before commit: run review, verify PWA and nav per their checklists.

​
Documentation Maintenance

Last Major Update: 2025-12-31 Recent consolidations and improvements (2025-01-27 to 2025-01-28):
  • ✅ Archived review/analysis files (13 files → archive)
    • All DEVELOPMENT_DOCS_* review/analysis files
    • CONSOLIDATION_ACTION_PLAN.md (plan implemented)
    • settings-page-pattern.md (consolidated)
  • ✅ Moved module-specific docs to appropriate locations (4 files)
  • ✅ Consolidated spacing documentation (2 files → 1)
  • ✅ Consolidated code review documentation (3 files → 1)
  • ✅ Consolidated settings pattern files (2 files → 1)
  • ✅ Created DEVELOPMENT_QUICK_REFERENCE.md for daily use
  • ✅ Created SETUP_QUICK_START.md for onboarding
  • ✅ Created NAVIGATION_GUIDE_INDEX.md for navigation documentation
  • ✅ Created guides: TROUBLESHOOTING_GUIDE.md,
    • DATABASE_DEVELOPMENT_GUIDE.md
    • API_DEVELOPMENT_GUIDE.md
    • PERFORMANCE_OPTIMIZATION_GUIDE.md
  • ✅ Enhanced README.md with Quick Start and Common Tasks sections
  • ✅ Added metadata, TOCs, quick references, and cross-references across all files
  • ✅ Fixed broken links and updated references to archived files
File Count: ~26 active files (down from 39 files - 33% reduction) Note: Historical review/analysis files were removed during docs consolidation. Recover any needed snapshots from Git history. For adding new development docs:
  • Follow file naming conventions above
  • Add entry to relevant section in this README
  • Link from main Documentation Hub if needed
  • Update “Last Updated” date

​
Historical Notes

Historical plans and one-off reviews were intentionally removed from active docs navigation to reduce noise. Use Git history for retrieval when needed.
Questions? Check the relevant guide above or search the development documentation directory.