Skip to content

Commit 62f3d31

Browse files
hyperpolymathclaude
andcommitted
docs: add TOPOLOGY.md
Document purpose, module structure, and data flow for this -iser tool. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent ec47354 commit 62f3d31

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

TOPOLOGY.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<!-- SPDX-License-Identifier: PMPL-1.0-or-later -->
2+
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
3+
# TOPOLOGY.md — verisimiser
4+
5+
## Purpose
6+
7+
verisimiser augments any existing database with the full VeriSimDB octad of capabilities (the eight cross-modal dimensions). It reads the target database schema and a `verisimiser.toml` manifest, then generates a sidecar overlay, query interceptors, drift detection, provenance chains, and temporal version history — without requiring schema migrations. verisimiser is priority #3 in the -iser family and is the primary path for adding VeriSimDB capabilities to legacy PostgreSQL, SQLite, or MongoDB deployments.
8+
9+
## Module Map
10+
11+
```
12+
verisimiser/
13+
├── src/
14+
│ ├── main.rs # CLI entry point (clap): init, generate, start, drift, provenance, history, status, octad
15+
│ ├── lib.rs # Library API
16+
│ ├── manifest/mod.rs # verisimiser.toml parser
17+
│ ├── codegen/mod.rs # Sidecar overlay and query interceptor generation
18+
│ ├── intercept/ # Query interception layer
19+
│ ├── tier1/ # Tier-1 octad dimension modules
20+
│ ├── tier2/ # Tier-2 octad dimension modules
21+
│ └── abi/ # Idris2 ABI bridge stubs
22+
├── examples/ # Worked examples
23+
├── verification/ # Proof harnesses
24+
├── container/ # Stapeln container ecosystem
25+
└── .machine_readable/ # A2ML metadata
26+
```
27+
28+
## Data Flow
29+
30+
```
31+
verisimiser.toml manifest
32+
33+
┌────▼────┐
34+
│ Manifest │ parse + validate database backend and octad dimension selections
35+
│ Parser │
36+
└────┬────┘
37+
│ validated augmentation config
38+
┌────▼────┐
39+
│ Analyser │ introspect target database schema, plan sidecar overlay
40+
└────┬────┘
41+
│ schema IR + octad plan
42+
┌────▼────┐
43+
│ Codegen │ emit generated/verisimiser/ (sidecar overlay, query interceptors,
44+
│ │ provenance chains, temporal history, drift detectors)
45+
└────┬────┘
46+
│ VeriSimDB octad augmentation artifacts
47+
┌────▼────┐
48+
│ Daemon │ start augmentation daemon alongside target database
49+
└─────────┘
50+
```

0 commit comments

Comments
 (0)