diff --git a/docs/architecture/README.md b/docs/architecture/README.md new file mode 100644 index 000000000..126358fc8 --- /dev/null +++ b/docs/architecture/README.md @@ -0,0 +1,5 @@ +# Table of Contents + +## Overview + +Overview diff --git a/docs/diagrams/overview.d2 b/docs/architecture/overview.d2 similarity index 84% rename from docs/diagrams/overview.d2 rename to docs/architecture/overview.d2 index 83c199b9e..bc719eb51 100644 --- a/docs/diagrams/overview.d2 +++ b/docs/architecture/overview.d2 @@ -8,6 +8,7 @@ compiler: { parse -> AST AST: Abstract Syntax Tree { shape: oval + fill: honeydew } AST -> compile @@ -16,6 +17,7 @@ compiler: { compiler.compile -> graph graph: Graph\n(shapes & connections) { shape: oval + fill: honeydew } graph -> Set Dimensions @@ -24,14 +26,21 @@ Set Dimensions -> Use given, premeasured dimensions -> measured graph measured graph: { shape: oval + fill: honeydew } measured graph -> layout engine -> positioned graph +positioned graph: { + shape: oval + fill: honeydew +} + positioned graph -> exporter -> diagram diagram: finalized diagram (styled) { shape: oval + fill: honeydew } diagram -> render SVG @@ -42,6 +51,7 @@ use sketch post processor -> SVG bytes SVG bytes: { shape: oval + fill: honeydew } SVG bytes -> screenshot for PNG: optional diff --git a/docs/diagrams/overview.svg b/docs/architecture/overview.svg similarity index 98% rename from docs/diagrams/overview.svg rename to docs/architecture/overview.svg index e38ca731a..313fe6542 100644 --- a/docs/diagrams/overview.svg +++ b/docs/architecture/overview.svg @@ -3,7 +3,7 @@ id="d2-svg" style="background: white;" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" -width="2339" height="1707" viewBox="-102 -102 2339 1707">