|
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 | | -;; META.a2ml — Meta-level information for otpiser |
4 | | - |
5 | | -(meta |
6 | | - (version "0.1.0") |
7 | | - (last-updated "2026-03-21") |
8 | | - |
9 | | - (architecture-decisions |
10 | | - (adr "001-iser-pattern" |
11 | | - (status "accepted") |
12 | | - (context "OTP supervision trees are powerful but hard to learn correctly") |
13 | | - (decision "Manifest-driven code generation: user describes services, otpiser generates the supervision tree") |
14 | | - (consequences "Users write zero Elixir code; all OTP complexity is handled by the -iser")) |
15 | | - |
16 | | - (adr "002-abi-ffi-standard" |
17 | | - (status "accepted") |
18 | | - (context "Need verified interop between Rust CLI, Elixir/BEAM runtime, and NIF bridge") |
19 | | - (decision "Idris2 ABI for formal proofs of tree correctness, Zig FFI for C-ABI NIF bridge") |
20 | | - (consequences "Compile-time guarantees that supervision trees are well-formed; zero runtime overhead")) |
21 | | - |
22 | | - (adr "003-strategy-selection" |
23 | | - (status "accepted") |
24 | | - (context "Choosing the right supervision strategy is the hardest part of OTP design") |
25 | | - (decision "Automatic strategy selection from service dependency analysis: independent → one_for_one, coupled → one_for_all, ordered → rest_for_one") |
26 | | - (consequences "Users describe relationships; otpiser computes optimal strategies")) |
27 | | - |
28 | | - (adr "004-restart-intensity" |
29 | | - (status "accepted") |
30 | | - (context "Incorrect max_restarts/max_seconds causes restart storms or premature shutdown") |
31 | | - (decision "Compute restart intensity from SLA definitions: high-availability services get aggressive budgets, best-effort services get conservative ones") |
32 | | - (consequences "Self-tuning fault tolerance without manual parameter guessing")) |
33 | | - |
34 | | - (adr "005-rsr-template" |
35 | | - (status "accepted") |
36 | | - (context "Need consistent project structure across 29+ -iser repos") |
37 | | - (decision "All repos cloned from rsr-template-repo with full CI/CD and governance") |
38 | | - (consequences "17 workflows, SECURITY.md, CONTRIBUTING, bot directives from day one"))) |
39 | | - |
40 | | - (development-practices |
41 | | - (language "Rust" (purpose "CLI orchestration and manifest parsing")) |
42 | | - (language "Idris2" (purpose "ABI formal proofs for supervision tree invariants")) |
43 | | - (language "Zig" (purpose "FFI C-ABI bridge for Erlang NIF generation")) |
44 | | - (language "Elixir" (purpose "Target language — generated code")) |
45 | | - (build-tool "cargo") |
46 | | - (ci "GitHub Actions (17 workflows)")) |
47 | | - |
48 | | - (design-rationale |
49 | | - (principle "Manifest-driven" |
50 | | - (explanation "User intent captured in otpiser.toml; supervision tree generation is deterministic and reproducible")) |
51 | | - (principle "Formally verified bridges" |
52 | | - (explanation "Idris2 dependent types prove supervision tree well-formedness at compile time")) |
53 | | - (principle "Zero target language exposure" |
54 | | - (explanation "Users never write Elixir/Erlang — otpiser generates everything including Application, Supervisor, GenServer, tests, and mix.exs")) |
55 | | - (principle "Let it crash, correctly" |
56 | | - (explanation "OTP's 'let it crash' philosophy is correct but easy to misconfigure — otpiser ensures the crash recovery strategy matches service semantics")))) |
| 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 | +# META.a2ml — Otpiser meta-level information |
| 5 | +[metadata] |
| 6 | +version = "0.1.0" |
| 7 | +last-updated = "2026-03-21" |
| 8 | + |
| 9 | +[project-info] |
| 10 | +license = "PMPL-1.0-or-later" |
| 11 | +author = "Jonathan D.A. Jewell (hyperpolymath)" |
| 12 | + |
| 13 | +[architecture-decisions] |
| 14 | +decisions = [ |
| 15 | + # No ADRs recorded |
| 16 | +] |
| 17 | + |
| 18 | +[development-practices] |
| 19 | +versioning = "SemVer" |
| 20 | +documentation = "AsciiDoc" |
| 21 | +build-tool = "just" |
| 22 | + |
| 23 | +[maintenance-axes] |
| 24 | +scoping-first = true |
| 25 | +axis-1 = "must > intend > like" |
| 26 | +axis-2 = "corrective > adaptive > perfective" |
| 27 | +axis-3 = "systems > compliance > effects" |
0 commit comments