| `docs/users/index.md` | User Documentation Hub | Directory map, user role definitions, and core workflow summaries. |
| `docs/users/getting-started.md` | Getting Started | First-time installation, `/vcon/setup` wizard, creating a client, and testing ingestion via `curl` and Python. |
| `docs/users/features/data-simulator.md` | Data Simulator | In-browser telemetry generation (`/vcon/simulator`), single vs batch dispatch, HTTP vs WebSocket transport, and preset sensor/e-commerce payloads. |
| `docs/users/features/data-export.md` | Streaming Data Export | Operational guide to `/vcon/export`, streaming filtered CSV and JSON files, UTC date filtering, and importing into pandas and Excel. |
| `docs/users/workflows.md` | Operational Workflows | Complete step-by-step user journeys: onboarding an admin, onboarding an SDK client, rotating platform JWT secret, and running disaster recovery backups. |
| `docs/dev/index.md` | Developer Hub | Contributor overview, architecture index, development philosophy, and repository roadmap. |
| `docs/dev/architecture.md` | Architecture Blueprint | Decoupled runtime architecture (Port 3000 Web vs Port 4000 Ingestion), internal bridge protocol, Redis AOF durability, and storage subsystems. |
| `docs/dev/codebase-structure.md` | Codebase Structure | Exhaustive file-by-file inventory of directories, source modules (`core/`, `app/`, `server/`, `components/`), and their relationships. |
| `docs/dev/local-setup.md` | Local Development Setup | Step-by-step workstation setup, Node.js 22 requirements, dual-terminal local workflow, and in-memory vs Docker container modes. |
| `docs/dev/api-reference.md` | API Reference Specification | Complete OpenAPI-style reference for all REST endpoints (`app/api/*`) and Socket.IO real-time events (`server/socket/handlers.js`). |
| `docs/reference/index.md` | Reference Index | Overview of platform specifications, configuration limits, and glossary. |
| `docs/reference/configuration-reference.md` | Configuration Reference | Exhaustive reference table of all environment variables, default values, bounds, and `/vcon/settings` allowlisted keys. |
| `docs/reference/dependencies.md` | Dependency Inventory | Audit of all runtime dependencies, dev tools, and Python client requirements with rationales. |
To ensure documentation remains permanently synchronized with the actual implementation across future pull requests and releases:
### Mandatory Update Triggers
1.**API & Route Changes**: If any endpoint under `app/api/` or Socket.IO event in `server/socket/handlers.js` is added, modified, or removed:
- Update `docs/dev/api-reference.md`.
- Update `docs/users/tutorials.md` and `docs/users/workflows.md` if user-facing.
2.**Configuration & Environment Changes**: If any environment variable in `.env.example` or setting in `core/adminSettings/settingsManager.ts` is modified:
3.**Database Schema Changes**: If any table, column, or constraint in `core/Database/database.ts` or `prisma/schema.prisma` is adjusted:
- Update `docs/dev/database-schema.md`.
4.**Storage & Ingestion Mechanics**: If batching, locking, rotation, or pruning algorithms in `core/Storage/` or `core/data/` change:
- Update `docs/dev/architecture.md` and `docs/users/features/partitioned-storage.md`.
5.**Cross-IDE Synchronization**: In compliance with `.ai-rules` and `AGENTS.md`, after every change session, `MEMORY.md` in the root directory must be updated to mirror documentation and code status.
### Zero-Hallucination Authoring Standards
- **Implementation is Truth**: Never document planned or intended behavior as existing capability.
- **Traceable Code References**: Every technical guide must reference verified file paths and actual function/class identifiers.
- **Executable Examples**: All `curl`, Python, TypeScript, and Docker commands must be verified and syntactically valid.