Skip to content

History / 01 Introduction and Goals

Revisions

  • Eradicate \`-escape rendering artifacts: AsciiDoc {empty} boundary attribute + passthrough conversion for angle-bracket spans Root cause: AsciiDoc smart-quote substitution + Pandoc DocBook→markdown backtick-escape interaction. When an AsciiDoc inline code-span `text` is immediately followed by a trigger character (letter, ASCII apostrophe, or ASCII double-quote), Pandoc escapes the opening backtick because the smart-quote substitution makes the code-span boundary ambiguous in markdown. Result: literal `\\`text` artifacts in the rendered wiki — the closing backtick is consumed by the entity, and the opening backtick appears as `\\`` text rather than a styled code span. Two-part fix: (1) Insert AsciiDoc `{empty}` attribute substitution between the closing backtick and the trigger character via a state-machine parser (`/tmp/fix_backtick_boundary.py`). `{empty}` is a zero-width attribute that breaks the AsciiDoc/Pandoc bonding without affecting rendered output. The parser tracks opening/closing backtick pairing using AsciiDoc constrained-span rules (opening flanked by start-of- line, whitespace, or specific opening punctuation; closing flanked by non-whitespace), so it only inserts at true closing positions. Applied 462 fixes across 14 .adoc source files (12 arc42 chapters plus 2 ISO 15288 lifecycle pages). (2) Convert 6 specific AsciiDoc inline code spans containing `<...>` angle brackets to `++...++` passthrough form. AsciiDoc inline code spans wrapping content with HTML-significant characters get the angle brackets escaped through the DocBook→markdown conversion, producing literal `\\<` and `\\>` plus the opening-backtick escape. Converting these to `++...++` passthrough preserves the content verbatim (the rendered output remains code-styled monospace). Fixed spans: ADR-026 G6 (match grammar, 4 spans); glossary's first_admit + fold_n + Term::FirstAdmit grammar forms. Build pipeline preserved; all 8 validators pass on clean rebuild (vendor/arc42-generator/build/ cleared); zero `\\` artifacts remain in any of the 22 rendered wiki pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

    @afflom afflom committed May 15, 2026
  • Rename prism-sdk → prism + canonical UOR-address surface (ADR-017) Two architectural changes on top of 063d0ac: 1. Crate rename: prism-sdk → prism. Symmetric with uor-foundation (no -sdk suffix on either). prism-verify stays separate to preserve ADR-005's verifier-minimal-surface property. The Prism repo continues publishing both prism and prism-verify. 2. Canonical UOR-address surface (ADR-017). prism's standard library types are canonical UOR-address mappings: each standard type's IRI is content-deterministic in its constraint declaration; two applications using the same standard type produce values addressing identically. Closure under uor-foundation (ADR-013) makes the canonicality hold derivatively rather than via a claimed namespace. The catalog stays in prism's crate documentation; the wiki commits to canonicality, not to a specific catalog. Rename mechanics: - 282+ occurrences of prism-sdk → prism across all 12 chapters - workspace.dsl: softwareSystem identifier prism → prismSystem (the container needed the prism identifier, and Structurizr DSL requires identifiers be unique workspace-wide) - workspace.dsl: container prismSdk → prism - workspace.dsl deployment instances: prismSdkDep → prismDep prismSdkLinked → prismLinked prismSdkVerifyLinked → prismLinkedInVerify (avoids clash with the existing prismVerifyLinked for prism-verify in the verification env) - 13 orphaned "SDK" prose references cleaned up - ADR-005 title trimmed to "Decompose Prism into three crates" - ADR-007 title: "foundation defines, prism bounds, author selects" New content: - §5.2 standard library row: amended to specify decomposition by uor-foundation's shape primitives + canonical UOR-address mapping note + reference to ADR-017 - §8 closure section: extended from 2 consequences to 4. Bullets 3 and 4 cover IRI determinacy (closure makes UOR addresses derivative of constraint declarations, not namespace-claimed) and author-declared types (standard library is convenience, not capability — authors declare their own first-class Prism types via prism's vocabulary re-exports) - ADR-017: full Nygard ADR with two rejected alternatives - Glossary: new entry "Canonical UOR-address mapping" The rename is purely nominative; every architectural commitment (sealing, principal data path, UORassembly, closure, mint primitives, repo split) holds identically before and after. ADR-017 is the only new architectural commitment. V1, V2, V3, V4, V5 all PASS. Stage 5 idempotence holds. 22 SVGs regenerated. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

    @afflom afflom committed May 4, 2026
  • Three-crate reallocation: substrate / runtime / replay façade Restructures the wiki to disentangle the conflation between uor-foundation (substrate) and Prism (the system Prism realizes). The architectural commitments do not change; the allocation of those commitments across the three crates does. Crate role allocation (was → is): uor-foundation "principal data path + 7 sealed types + traits" → substrate. Type-declaration vocabulary (incl. shape proc-macros via internal sub-crate); 4 UOR-domain sealed types (Datum, Triad, Derivation, FreeRank); wire-format type definitions as data; mint primitives as cross-crate construction surface. uor-foundation-sdk → prism-sdk was "compile-time enforcement only, no runtime code" → Prism runtime. Pipeline runtime; 3 Prism-mechanism sealed types (Validated, Grounded, Certified); operation-declaration vocabulary; standard type library. Closed under uor-foundation's vocabulary. Re-exports uor-foundation's vocabulary so authors import only prism-sdk. uor-foundation-verify → prism-verify was "validates traces; depends on foundation type defs and replay primitives" → replay façade. Re-exports prism-sdk's certify_from_trace and Certified, plus uor-foundation's wire-format types. Carries no implementation. Source-side changes: - 12 chapters substantively amended for the new allocation: ch1 Introduction: three-crate roles + sealed-type allocation note ch2 TC-02 + TC-03 prose: cross-crate seal clarification ch3 Channels table: substantive updates per row + new mint-primitive channel; cross-boundary Sealing bullet ch4 6-row strategic table substantively rewritten; "How These Decisions Compose" rewritten ch5 Black-box descriptions and component decompositions substantively rewritten; pipeline relocates to prism-sdk; replay relocates to prism-sdk; mint-primitives component added; new L3 sub-section for prism-sdk seal regime + replay ch6 Scenario 1 properties bullet, Scenario 2 control transfer, Scenario 3 substantive steps, Cross-Scenario Properties first bullet substantively updated ch7 Mapping table cell contents change (prism-sdk now Present in user-execution and user-verification environments); repo-source clarification in Level 2 prose ch8 Sealing Discipline rewritten; UORassembly Contract Definition amended; #![no_std] Posture rewritten; Feature Flags expanded; three new H2s: Operation Declaration, Closure Under uor-foundation, Cross-Crate Construction Surface ch9 ADR-005, 006, 007, 011 substantively rewritten; ADR-002, 003, 008, 009, 010 amended (renames + role refs); five new ADRs: ADR-012 Pipeline runtime placement; ADR-013 Closure of prism-sdk under uor-foundation; ADR-014 Operation declaration vs operation shipment; ADR-015 Repo split (UOR-Framework + Prism); ADR-016 Cross-crate seal mechanism (mint primitives) ch10 QS-01, QS-04 Scenario A/B, QS-05 substantive updates ch11 TR-01 substantive (proc-macro location); TR-03 substantive (cross-crate flag combinatorics); TR-06 substantive (cross-repo coordination); two new TRs: TR-08 vocabulary insufficiency, TR-09 prism-sdk version pin lag ch12 Glossary: 18 entries updated for new sealed-type allocations + crate roles; 5 new entries (prism-sdk, prism-verify, mint primitive, operation declaration, closure under uor-foundation); plus certify_from_trace, replay, seal regime, vocabulary re-exports as new component entries - workspace.dsl: container descriptions rewritten; uor-foundation L3 drops pipelineComp, gains mintPrimitivesComp + 4 shape macro components; prism-sdk L3 replaces 4-component view with 6 (pipeline, sealRegime, replay, operationDeclaration, standardTypeLibrary, vocabularyReExports); prism-verify L3 re-anchored at prism-sdk's replay; dynamic views updated for pipeline-in-prism-sdk; deployment views add prismSdkLinked to user-execution and user-verification environments - 22 SVGs regenerated (Structurizr export) V1, V2, V3, V4, V5 all PASS. Stage 5 idempotence holds. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

    @afflom afflom committed May 4, 2026
  • Phase 3 first content: import full Prism architecture wiki Replaces the 12 heading-only chapter skeletons and the empty workspace.dsl with their authored versions, plus the 11 Structurizr SVG views (+ 11 -key.svg legends) generated from the workspace. Chapters added: 01 Introduction and Goals 103 lines (4 H2) 02 Architecture Constraints 107 lines (3 H2) 03 Context and Scope 74 lines (3 H2) 04 Solution Strategy 59 lines (2 H2) 05 Building Block View 249 lines (3 H2) 06 Runtime View 382 lines (5 H2 + upstream placeholders) 07 Deployment View 199 lines (4 H2) 08 Cross-cutting Concepts 290 lines (9 H2 + upstream placeholders) 09 Architecture Decisions 387 lines (11 ADRs) 10 Quality Requirements 211 lines (4 H2) 11 Risks and Technical Debts 197 lines (7 TRs) 12 Glossary 67 lines (1 H2) C4 model added (12 view keys, 22 SVGs after legends): L1: c4-l1-system-context L2: c4-l2-prism-containers L3: c4-l3-{foundation,sdk,verify}-components Dynamic: c4-dynamic-{principal-data-path, trace-replay, uorassembly-enforcement, distribute-and-run} Deployment: c4-deployment-{application,verifier} Source-side fix-ups applied during validation: - workspace.dsl: removed `applicationUser -> uorFoundationVerify` from the system-landscape-scoped `c4-dynamic-distribute-and-run` view; Structurizr rejects person->container relationships at landscape scope. - Chapters 5,6,7,8,10,11: wrapped `#![no_std]` and `#![feature(generic_const_exprs)]` in `++...++` passthrough so the `#` characters do not collide with AsciiDoc's mark-text formatting and produce malformed DocBook in V2's pandoc step. Rendered output unchanged (still monospace `#![...]`). V1 still PASSes (heading text comparison is exact-match against upstream; chapters add new H2 sections beyond the upstream set, which V1 explicitly allows as a structural superset). Imported v1-structural-alignment.rb and v3-structurizr.sh from the content drop were stale earlier versions and were not copied -- current in-tree versions are the working ones. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

    @afflom afflom committed May 4, 2026
  • Phase 0 + Phase 1 + Phase 2 bootstrap Adds the full validation, build, and authoring infrastructure defined in the parent UOR-Framework repo's wiki-definition.md, plus skeleton chapter sources and the first end-to-end-passing rendered output. Phase 0 (tooling): - 12 scripts under scripts/ (V1..V5 validators, install-tools, validate, build, render-wiki-frame, stage-to-wiki-root, check-wiki-state) - vendor/arc42-generator submodule pinned at 46bd7ce (Feb 2026) - arc42-template pinned at b29e08 via tools/arc42-template-pin.txt (overrides the generator's own stale submodule pin) - structurizr.war v2026.04.19 (Playwright variant) pinned in tools/checksums.txt by SHA-256 - cmark-gfm 0.29.0.gfm.13, built from source by install-tools.sh - Gemfile pins asciidoctor ~> 2.0, github-markup ~> 5.0, commonmarker ~> 0.23 (5.0.x github-markup needs the 0.x API) - tools/versions.txt as build.sh Stage 1's pin authority Phase 1 (skeleton sources): - src/arc42/adoc/NN_*.adoc — 12 chapter skeletons matching upstream H1+H2 - src/arc42/arc42-template.adoc — top-level include for direct asciidoctor - src/arc42/version.properties - src/c4/workspace.dsl — empty workspace (V3 PASS / 0 views) - src/wiki/{Home,Sidebar,Footer}.adoc Phase 2 (rendered artifacts at the wiki root): - 12 chapter files NN-Title-Case-Name.md - Home.md, _Sidebar.md, _Footer.md - images/ (placeholder .gitkeep until the C4 model gains views) Validators: - V1 — structural alignment with upstream arc42-template - V2 — drives the arc42-generator Docker pipeline (gitHubMarkdownMP / plain), bypassing build-arc42.sh's destructive submodule reset - V3 — Structurizr DSL validate + SVG export (skips export when no views, avoiding Playwright Chromium dependency on empty workspaces) - V4 — cmark-gfm with GitHub's wiki extension set - V5 — github-markup gem to catch markup-stage rendering failures build.sh runs the five-stage pipeline (pre-flight pin check, validate, render wiki-frame, stage to wiki root, idempotence check via cmp). Spec deviations (vs wiki-definition.md): - Chapter 3 filename is 03_context_and_scope.adoc (upstream-actual), not 03_system_scope_and_context.adoc; rendered as 03-Context-and-Scope.md - arc42-template pinned at our level (separate file) rather than relying on the generator's transitive pin, because arc42-generator's Templates.groovy expects a layout newer than its own pinned submodule - v2-arc42-build.sh invokes `groovy build.groovy` directly, skipping the generator's build-arc42.sh wrapper (which wipes our staged edits and fails inside our nested-submodule git layout) - V2's chosen output format is gitHubMarkdownMP (Multi-Page GFM) for per-chapter files, not the spec's unspecified default Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

    @afflom afflom committed May 4, 2026