Skip to content

Commit 9fb8353

Browse files
committed
docs(sim-ui): added d2
1 parent 461101e commit 9fb8353

File tree

2 files changed

+164
-0
lines changed

2 files changed

+164
-0
lines changed

ui/docs/component.d2

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
title: {
2+
label: "UI Web App - Component Diagram"
3+
near: top-center
4+
shape: text
5+
style.font-size: 24
6+
style.bold: true
7+
}
8+
9+
# Styles
10+
classes: {
11+
component: {
12+
style: {
13+
stroke: "#2a2a2a"
14+
fill: "#ffffff"
15+
font-color: "#2a2a2a"
16+
border-radius: 10
17+
shadow: true
18+
}
19+
}
20+
container: {
21+
style: {
22+
stroke: "#2a2a2a"
23+
fill: "#f5f5f5"
24+
font-color: "#2a2a2a"
25+
border-radius: 10
26+
shadow: true
27+
}
28+
}
29+
subcomponent: {
30+
style: {
31+
stroke: "#666666"
32+
fill: "#ffffff"
33+
font-color: "#2a2a2a"
34+
border-radius: 5
35+
shadow: false
36+
}
37+
}
38+
}
39+
40+
# Main Containers
41+
ui-app: {
42+
class: container
43+
label: "UI Web App"
44+
45+
frontend: {
46+
class: component
47+
label: "Frontend\n- React Components\n- State Management\n- UI Rendering"
48+
49+
components: {
50+
class: subcomponent
51+
label: "UI Components\n- Buttons\n- Charts\n- Tables"
52+
}
53+
54+
state: {
55+
class: subcomponent
56+
label: "State Management\n- Redux\n- Context API"
57+
}
58+
}
59+
60+
backend: {
61+
class: component
62+
label: "Backend API\n- Data Fetching\n- Trace Processing"
63+
64+
api_routes: {
65+
class: subcomponent
66+
label: "API Routes\n- /api/messages\n- /api/trace"
67+
}
68+
69+
data_processing: {
70+
class: subcomponent
71+
label: "Data Processing\n- JSON Parsing\n- Data Transformation"
72+
}
73+
}
74+
}
75+
76+
external-systems: {
77+
class: container
78+
label: "Rust Simulation"
79+
80+
sim-rs: {
81+
class: component
82+
label: "sim-rs\n- Trace Generation\n- Simulation Engine"
83+
}
84+
}
85+
86+
# Relationships
87+
ui-app.frontend -> ui-app.backend: "Fetches data from"
88+
ui-app.backend -> external-systems.sim-rs: "Reads trace data from"
89+
ui-app.frontend.components -> ui-app.frontend.state: "Uses for state management"
90+
ui-app.backend.api_routes -> ui-app.backend.data_processing: "Processes data for"

ui/docs/container.d2

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
title: {
2+
label: "UI Web App - Container Diagram"
3+
near: top-center
4+
shape: text
5+
style.font-size: 24
6+
style.bold: true
7+
}
8+
9+
# Styles
10+
classes: {
11+
container: {
12+
style: {
13+
stroke: "#2a2a2a"
14+
fill: "#f5f5f5"
15+
font-color: "#2a2a2a"
16+
border-radius: 10
17+
shadow: true
18+
}
19+
}
20+
component: {
21+
style: {
22+
stroke: "#2a2a2a"
23+
fill: "#ffffff"
24+
font-color: "#2a2a2a"
25+
border-radius: 10
26+
shadow: true
27+
}
28+
}
29+
external: {
30+
style: {
31+
stroke: "#666666"
32+
fill: "#e0e0e0"
33+
font-color: "#2a2a2a"
34+
border-radius: 5
35+
shadow: false
36+
}
37+
}
38+
}
39+
40+
# Main Containers
41+
ui-web-app: {
42+
class: container
43+
label: "UI Web App"
44+
45+
browser: {
46+
class: component
47+
label: "Web Browser\n- User Interface\n- Data Visualization"
48+
}
49+
50+
server: {
51+
class: component
52+
label: "Backend Server\n- API Endpoints\n- Data Processing"
53+
}
54+
}
55+
56+
external-systems: {
57+
class: container
58+
label: "Rust Simulation"
59+
60+
sim-rs: {
61+
class: external
62+
label: "sim-rs\n- Trace Generation"
63+
}
64+
65+
trace-file: {
66+
class: external
67+
label: "Trace File\n- messages.jsonl"
68+
}
69+
}
70+
71+
# Relationships
72+
ui-web-app.browser -> ui-web-app.server: "Requests data from"
73+
ui-web-app.server -> external-systems.trace-file: "Reads data from"
74+
external-systems.sim-rs -> external-systems.trace-file: "Generates"

0 commit comments

Comments
 (0)