Vrida Documentation
Map of the documentation structure. Start here.
Folders
- ai/ — The AI Capability Plane: how AI behaves across the whole system (governance + capabilities). Cross-cutting, not per-module.
- architecture/ — System-wide technical decisions: tenancy, RLS, offline strategy, AI capacity, conventions.
- database/ — Authoritative schema definitions and the schema-design discipline.
- modules/ — One subfolder per module. Each module's schema, knowledge article, AI mapping, and service contract.
- decisions/ — Architecture Decision Records (ADRs). One file per non-obvious decision: what, why, what was rejected.
- business-requirements/ — Market research, gaps registry, scope (in/out).
- process/ — How we work: the module pipeline, the two gates (design-lock, ship) and their checklists, templates.
- index/ — THE SINGLE SOURCE OF TRUTH for live status: module count, schema count, table/column counts, per-module gate status. Everything else points here; nothing else duplicates these numbers.
Source-of-truth rule
Live status and counts live ONLY in /index. No other doc (including any README) restates them. If you need to know "where are we / how many," read /index.
Working rule
A module advances through the pipeline defined in /process. It is not "locked" or "shipped" until it passes the corresponding gate checklist there.