Skip to content

Commit ee20e6b

Browse files
committed
architecture page: explain how the engine works + add diagrams
The previous architecture page was a curated list of pointers into the audit-docs corpus. Rewrite it as an actual deep-dive that explains how the engine produces records, with Mermaid flow diagrams for the load-bearing concepts. Sections added: - The mental model in one diagram (DSL → plan → executor → IR → record) - How the DSL becomes a simulation (full lowering pipeline) - The seven engine invariants in user-friendly tone with diagrams where they help (constrain-before-propose, replay admissibility chain, live-call refresh) - Three streams per pass (trace / events / Simulation) - Plan signature replay gate (three-stage check) - Two-layer integrity model (AIRR validator + cache parity) - Audit-first workflow Enable Mermaid via pymdownx.superfences custom_fences + a small init script that loads mermaid from CDN as ESM. The init also re-runs on Material's instant-nav swaps so diagrams render after client-side navigation. Audit-docs deep links switched from relative paths to GitHub absolute URLs (audit-docs/ is at repo root, outside the MkDocs docs_dir, so relative paths can't resolve in the built site).
1 parent 7c05b27 commit ee20e6b

3 files changed

Lines changed: 548 additions & 193 deletions

File tree

mkdocs.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,13 @@ theme:
8282
extra_css:
8383
- stylesheets/extra.css
8484

85+
# Mermaid for architecture flow diagrams. Loaded as an ES module from
86+
# CDN so we don't ship the (~1MB) library locally. The pymdownx
87+
# custom_fences config above turns ```mermaid blocks into
88+
# <pre class="mermaid"> elements; mermaid.run() picks them up.
89+
extra_javascript:
90+
- js/mermaid-init.js
91+
8592
markdown_extensions:
8693
- admonition
8794
- attr_list
@@ -92,7 +99,11 @@ markdown_extensions:
9299
permalink: true
93100
toc_depth: 3
94101
- pymdownx.details
95-
- pymdownx.superfences
102+
- pymdownx.superfences:
103+
custom_fences:
104+
- name: mermaid
105+
class: mermaid
106+
format: !!python/name:pymdownx.superfences.fence_code_format
96107
- pymdownx.snippets
97108
- pymdownx.tabbed:
98109
alternate_style: true

0 commit comments

Comments
 (0)