Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Architecture diagrams #706

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/architecture/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Table of Contents

## Overview

<img src="./overview.svg" alt="Overview" />
61 changes: 61 additions & 0 deletions docs/architecture/overview.d2
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
input: |d2
# D2 script
hello -> world
|

input -> compiler

compiler: {
width: 300
height: 100
style: {
fill: "#7B90D2"
font-color: white
}
}

compiler -> graph
graph: Graph\n(shapes & connections) {
shape: oval
style.fill: "#A8D8B9"
}

configs -> graph mods

graph -> graph mods -> layout


# Set Dimensions -> Use ruler to measure all texts -> measured graph
# Set Dimensions -> Use given, premeasured dimensions -> measured graph

# measured graph: {
# shape: oval
# style.fill: honeydew
# }
#
# measured graph -> layout engine -> positioned graph
#
# positioned graph: {
# shape: oval
# style.fill: honeydew
# }
#
# positioned graph -> exporter -> diagram
#
# diagram: finalized diagram (styled) {
# shape: oval
# style.fill: honeydew
# }
#
# diagram -> render SVG
#
# render SVG -> use sketch post processor: optional
#
# use sketch post processor -> SVG bytes
#
# SVG bytes: {
# shape: oval
# style.fill: honeydew
# }
#
# SVG bytes -> screenshot for PNG: optional
109 changes: 109 additions & 0 deletions docs/architecture/overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.