commit - release 1

docs/diagrams/README.md

@@ -0,0 +1,26 @@
+# Generated Diagrams
+
+This directory contains diagrams generated from topology compilation.
+
+## What these files are
+- Derived artifacts generated from:
+  - compiled topology graph
+  - distance (accumulated latency) metadata
+  - view/layout rules (ADR-0005)
+
+These files are meant for quick visual inspection and review.
+
+## Default outputs
+- SIP view: `sip_view.mmd` (and/or `sip_view.dot`)
+- CUBE view: `cube_view.mmd` (and/or `cube_view.dot`)
+- PE view: `pe_view.mmd` (and/or `pe_view.dot`)
+
+## How to preview
+- In VS Code:
+  - open `.mmd` or `.md` containing Mermaid blocks and use Markdown Preview
+  - for `.dot`, use a Graphviz preview extension or `dot -Tpng`
+
+## Notes
+- Diagrams are representative and distance-aware by default.
+- Instance indices are not required unless debugging asymmetry.
+- Outputs should be deterministic for the same topology and rules.