You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+25-19Lines changed: 25 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,12 @@
2
2
3
3
This folder documents the **Vortex simulation backend** that powers the UI in this repo.
4
4
5
+
Docs are grouped by intent:
6
+
7
+
-`docs/simulation/` — core simulation specs, architecture, and implementation plan
8
+
-`docs/ops/` — operational runbook for the backend
9
+
-`docs/paper/` — working reference copy of the Vortex 1.0 paper
10
+
5
11
## Overview
6
12
7
13
This repo ships two pieces together:
@@ -20,7 +26,7 @@ The simulation is **not** an on-chain implementation. Humanode mainnet is used o
20
26
21
27
The UI reads from `/api/*`. The contract is kept stable so the backend can evolve without forcing UI churn:
22
28
23
-
- Contract source of truth: `docs/vortex-simulation-api-contract.md`
29
+
- Contract source of truth: `docs/simulation/vortex-simulation-api-contract.md`
24
30
- TS DTO types used by the UI: `src/types/api.ts`
25
31
26
32
In v1, reads are backed by a transitional `read_models` table (and optional overlays from normalized tables), so pages can render without requiring the full normalized domain schema on day one.
@@ -67,20 +73,20 @@ Goal: keep a tight, professional set of docs that answers:
67
73
68
74
## Reading order
69
75
70
-
1.`docs/vortex-simulation-scope-v1.md` — v1 scope, explicit non-goals, and what “done” means
Copy file name to clipboardExpand all lines: docs/simulation/vortex-simulation-data-model.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The schema is implemented in `db/schema.ts` with migrations under `db/migrations
16
16
17
17
Purpose:
18
18
19
-
- Store JSON payloads that directly match the DTOs in `docs/vortex-simulation-api-contract.md`.
19
+
- Store JSON payloads that directly match the DTOs in `docs/simulation/vortex-simulation-api-contract.md`.
20
20
21
21
Modes:
22
22
@@ -90,7 +90,7 @@ Planned (v2+):
90
90
91
91
- The draft `payload` will evolve from a single “project-shaped” object with optional `metaGovernance` into a **discriminated union** aligned with proposal wizard templates (project vs system-change flows).
92
92
- The wizard architecture and phased migration strategy are described in:
0 commit comments