1- # ⚠️ STOP - CRITICAL READING REQUIRED
2-
3- **THIS FILE MUST BE READ FIRST BY ALL AI AGENTS**
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+ #
4+ # STOP - CRITICAL READING REQUIRED
5+ #
6+ # THIS FILE MUST BE READ FIRST BY ALL AI AGENTS
47
58## WHAT IS THIS?
69
7- This is the AI manifest for **[YOUR-REPO-NAME] **. It declares:
10+ This is the AI manifest for **verisimiser **. It declares:
811- Canonical file locations (where things MUST be, and nowhere else)
912- Critical invariants (rules that must NEVER be violated)
1013- Repository structure and organization
1114
15+ **verisimiser** augments existing databases with VeriSimDB octad capabilities.
16+ It wraps PostgreSQL, SQLite, MongoDB, Redis, and other backends to add eight
17+ octad dimensions (data, metadata, provenance, lineage, constraints, access
18+ control, temporal, simulation) without requiring database migration.
19+
1220## CANONICAL LOCATIONS (UNIVERSAL RULE)
1321
1422### Machine-Readable Metadata: `.machine_readable/` ONLY
1523
16- These 6 a2ml files MUST exist in `.machine_readable/` directory ONLY:
24+ These 6 a2ml files MUST exist in `.machine_readable/6a2/ ` directory ONLY:
17251. **STATE.a2ml** - Project state, progress, blockers
18262. **META.a2ml** - Architecture decisions, governance
19273. **ECOSYSTEM.a2ml** - Position in ecosystem, relationships
@@ -55,7 +63,7 @@ Policy enforcement contracts (k9, dust, lust, must, trust).
5563### AI Configuration & Guides: `.machine_readable/ai/` ONLY
5664
5765- `AI.a2ml` - Language-specific or LLM-specific patterns
58- - `PLACEHOLDERS.md ` - Bootstrap guide
66+ - `PLACEHOLDERS.adoc ` - Bootstrap guide
5967
6068### Community & Forge Metadata: `.github/` ONLY
6169
@@ -80,42 +88,73 @@ Policy enforcement contracts (k9, dust, lust, must, trust).
80886. **Container images** - MUST use Chainguard base (`cgr.dev/chainguard/wolfi-base:latest` or `cgr.dev/chainguard/static:latest`)
81897. **Container runtime** - Podman, never Docker. Files are `Containerfile`, never `Dockerfile`
82908. **Container orchestration** - `selur-compose`, never `docker-compose`
91+ 9. **Tier isolation** - Tier 1 capabilities NEVER write to the target database
92+ 10. **Sidecar integrity** - Provenance hash chains are append-only and tamper-evident
93+
94+ ## VERISIMISER-SPECIFIC INVARIANTS
95+
96+ - **Octad dimensions**: data, metadata, provenance, lineage, constraints, access-control, temporal, simulation
97+ - **Tier 1 (piggybacks)**: drift detection, provenance tracking, temporal versioning -- sidecar-only
98+ - **Tier 2 (overlays)**: graph, vector, tensor, semantic, document, spatial -- additional storage
99+ - **Supported backends**: PostgreSQL, SQLite, MongoDB, Redis (extensible)
100+ - **VQL-UT**: Type-safe query interface for octad queries
83101
84102## REPOSITORY STRUCTURE
85103
86104This repo follows the **Dual-Track** architecture:
87105
88106```
89- [YOUR-REPO-NAME] /
107+ verisimiser /
90108├── 0-AI-MANIFEST.a2ml # THIS FILE (start here)
91109├── README.adoc # High-level orientation (Rich Human)
92110├── ROADMAP.adoc # Future direction
93111├── CONTRIBUTING.adoc # Human contribution guide
94- ├── GOVERNANCE.adoc # Decision-making model
95112├── Justfile # Task runner
96113├── Containerfile # OCI build
97- ├── LICENSE # Primary license
114+ ├── Cargo.toml # Rust build config
115+ ├── LICENSE # Primary license (PMPL-1.0-or-later)
98116├── src/ # Source code
117+ │ ├── main.rs # CLI entry point (clap subcommands)
118+ │ ├── lib.rs # Library root
119+ │ ├── manifest/ # TOML manifest parsing
120+ │ ├── tier1/ # Tier 1 piggyback capabilities
121+ │ │ ├── drift.rs # Cross-modal drift detection
122+ │ │ ├── provenance.rs # SHA-256 hash-chain provenance
123+ │ │ └── temporal.rs # Temporal versioning sidecar
124+ │ ├── tier2/ # Tier 2 augmentation overlays
125+ │ ├── abi/ # ABI module (Rust side)
126+ │ ├── intercept/ # Per-database interception strategies
99127│ └── interface/ # Verified Interface Seams
100128│ ├── abi/ # Idris2 ABI (The Spec)
129+ │ │ ├── Types.idr # OctadDimension, DatabaseBackend, etc.
130+ │ │ ├── Layout.idr # Octad record memory layout
131+ │ │ └── Foreign.idr # Database connection, overlay, VQL-UT FFI
101132│ ├── ffi/ # Zig FFI (The Bridge)
133+ │ │ ├── build.zig
134+ │ │ ├── src/main.zig
135+ │ │ └── test/integration_test.zig
102136│ └── generated/ # C Headers (The Result)
103137├── container/ # Stapeln container ecosystem
104138├── docs/ # Technical depths
105139│ ├── attribution/ # Citations, owners, maintainers (adoc)
106- │ ├── architecture/ # Topology, diagrams
140+ │ ├── architecture/ # Topology, diagrams, threat model
107141│ ├── theory/ # Domain theory
108- │ └── practice/ # Manuals
109- ├── docs/legal/ # Legal exhibits and full texts
142+ │ └── legal/ # Legal exhibits and full texts
110143└── .machine_readable/ # ALL machine-readable metadata
144+ └── 6a2/ # STATE, META, ECOSYSTEM, AGENTIC, NEUROSYM, PLAYBOOK
111145```
112146
113147## SESSION STARTUP CHECKLIST
114148
115- ✅ Read THIS file (0-AI-MANIFEST.a2ml) first
116- ✅ Understand canonical location: `.machine_readable/`
117- ✅ State understanding of canonical locations
149+ 1. Read THIS file (0-AI-MANIFEST.a2ml) first
150+ 2. Understand canonical location: `.machine_readable/`
151+ 3. State understanding of canonical locations
152+ 4. Read `.machine_readable/6a2/STATE.a2ml` for current project state
118153
119154## ATTESTATION PROOF
120155
121- **"I have read the AI manifest. All machine-readable content (state files, anchors, policies, bot directives, contractiles, AI guides) is located in `.machine_readable/` ONLY, and community metadata is in `.github/`. I will not create duplicate files in the root directory."**
156+ **"I have read the AI manifest for verisimiser. All machine-readable content
157+ (state files, anchors, policies, bot directives, contractiles, AI guides) is
158+ located in `.machine_readable/` ONLY, and community metadata is in `.github/`.
159+ I will not create duplicate files in the root directory. Tier 1 capabilities
160+ never write to the target database."**
0 commit comments