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:
8- - Canonical file locations (where things MUST be, and nowhere else)
9- - Critical invariants (rules that must NEVER be violated)
10- - Repository structure and organization
10+ This is the AI manifest for **oblibeniser** — a tool that makes operations
11+ reversible and auditable via Oblibeny (Czech: "favourite"), a nextgen language
12+ for reversible computing.
13+
14+ Core concept: every forward operation has a provable inverse, enabling undo,
15+ audit trails, and time-travel debugging.
1116
1217## CANONICAL LOCATIONS (UNIVERSAL RULE)
1318
1419### Machine-Readable Metadata: `.machine_readable/` ONLY
1520
16- These 6 a2ml files MUST exist in `.machine_readable/` directory ONLY:
21+ These 6 a2ml files MUST exist in `.machine_readable/6a2/ ` directory ONLY:
17221. **STATE.a2ml** - Project state, progress, blockers
18232. **META.a2ml** - Architecture decisions, governance
19243. **ECOSYSTEM.a2ml** - Position in ecosystem, relationships
@@ -55,7 +60,7 @@ Policy enforcement contracts (k9, dust, lust, must, trust).
5560### AI Configuration & Guides: `.machine_readable/ai/` ONLY
5661
5762- `AI.a2ml` - Language-specific or LLM-specific patterns
58- - `PLACEHOLDERS.md ` - Bootstrap guide
63+ - `PLACEHOLDERS.adoc ` - Bootstrap guide
5964
6065### Community & Forge Metadata: `.github/` ONLY
6166
@@ -80,41 +85,61 @@ Policy enforcement contracts (k9, dust, lust, must, trust).
80856. **Container images** - MUST use Chainguard base (`cgr.dev/chainguard/wolfi-base:latest` or `cgr.dev/chainguard/static:latest`)
81867. **Container runtime** - Podman, never Docker. Files are `Containerfile`, never `Dockerfile`
82878. **Container orchestration** - `selur-compose`, never `docker-compose`
88+ 9. **Reversibility invariant** - Every ReversibleOperation MUST have a provable inverse
89+ 10. **Audit chain integrity** - Audit entries MUST be hash-chained; breaks are critical errors
8390
8491## REPOSITORY STRUCTURE
8592
8693This repo follows the **Dual-Track** architecture:
8794
8895```
89- [YOUR-REPO-NAME] /
96+ oblibeniser /
9097├── 0-AI-MANIFEST.a2ml # THIS FILE (start here)
9198├── README.adoc # High-level orientation (Rich Human)
9299├── ROADMAP.adoc # Future direction
93100├── CONTRIBUTING.adoc # Human contribution guide
94- ├── GOVERNANCE.adoc # Decision-making model
101+ ├── Cargo.toml # Rust CLI project
95102├── Justfile # Task runner
96103├── Containerfile # OCI build
97- ├── LICENSE # Primary license
104+ ├── LICENSE # Primary license (PMPL-1.0-or-later)
98105├── src/ # Source code
106+ │ ├── main.rs # CLI entrypoint
107+ │ ├── lib.rs # Library root
108+ │ ├── manifest/ # oblibeniser.toml parser
109+ │ ├── codegen/ # Oblibeny reversible wrapper codegen
99110│ └── interface/ # Verified Interface Seams
100- │ ├── abi/ # Idris2 ABI (The Spec)
111+ │ ├── abi/ # Idris2 ABI (Types, Layout, Foreign)
112+ │ │ ├── Types.idr # ReversibleOperation, InverseProof, AuditEntry, etc.
113+ │ │ ├── Layout.idr # C-ABI struct layouts with proofs
114+ │ │ └── Foreign.idr # FFI declarations for all operations
101115│ ├── ffi/ # Zig FFI (The Bridge)
116+ │ │ ├── build.zig
117+ │ │ ├── src/main.zig # FFI implementation
118+ │ │ └── test/ # Integration tests
102119│ └── generated/ # C Headers (The Result)
103120├── container/ # Stapeln container ecosystem
104121├── docs/ # Technical depths
105- │ ├── attribution/ # Citations, owners, maintainers (adoc)
122+ │ ├── attribution/ # Citations, owners, maintainers
106123│ ├── architecture/ # Topology, diagrams
107- │ ├── theory/ # Domain theory
124+ │ ├── theory/ # Domain theory (reversible computing)
108125│ └── practice/ # Manuals
109- ├── docs/legal/ # Legal exhibits and full texts
110126└── .machine_readable/ # ALL machine-readable metadata
127+ └── 6a2/ # STATE, META, ECOSYSTEM, etc.
111128```
112129
130+ ## DOMAIN CONCEPTS
131+
132+ - **ReversibleOperation**: A forward operation paired with its inverse
133+ - **InverseProof**: Dependent-type proof that `inverse(forward(x)) = x`
134+ - **AuditEntry**: Hash-chained record of who did what, when
135+ - **StateSnapshot**: Serialised system state before/after an operation
136+ - **UndoStack**: Bounded LIFO stack of operations for time-travel
137+
113138## SESSION STARTUP CHECKLIST
114139
115- ✅ Read THIS file (0-AI-MANIFEST.a2ml) first
116- ✅ Understand canonical location: `.machine_readable/`
117- ✅ State understanding of canonical locations
140+ Read THIS file (0-AI-MANIFEST.a2ml) first
141+ Understand canonical location: `.machine_readable/`
142+ State understanding of canonical locations
118143
119144## ATTESTATION PROOF
120145
0 commit comments