Skip to content

Commit 6ed7eb0

Browse files
committed
Include visualizer in docs site
1 parent 840f1ee commit 6ed7eb0

File tree

2 files changed

+53
-2
lines changed

2 files changed

+53
-2
lines changed

.github/workflows/docs.yaml

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,47 @@ jobs:
7272
git commit -m "Auto-generate diagram PNGs [skip ci]"
7373
git push origin HEAD:${{ github.head_ref || github.ref_name }}
7474
75+
viz-build:
76+
name: "Build Visualizer"
77+
runs-on: ubuntu-22.04
78+
steps:
79+
- name: 📥 Checkout repository
80+
uses: actions/checkout@v4
81+
with:
82+
fetch-depth: 2
83+
84+
- name: 🛠️ Setup Node.js
85+
uses: actions/setup-node@v4
86+
with:
87+
node-version: 22
88+
cache: "yarn"
89+
cache-dependency-path: ./ui/yarn.lock
90+
91+
- name: 📦 Install dependencies
92+
working-directory: ui
93+
run: yarn install
94+
95+
- name: 🏗️ Build visualizer
96+
working-directory: ui
97+
run: |
98+
yarn build
99+
100+
- name: 🚢 Upload visualizer static site
101+
id: upload_viz
102+
uses: actions/upload-artifact@v4
103+
with:
104+
name: visualizer
105+
path: |
106+
dist/assets
107+
dist/topologies
108+
dist/traces
109+
dist/scenarios\.json
110+
111+
75112
docs-build:
76113
name: "Build"
77114
runs-on: ubuntu-22.04
115+
needs: viz-build
78116
outputs:
79117
has_changes: ${{ steps.check_changes.outputs.has_changes }}
80118
steps:
@@ -83,11 +121,12 @@ jobs:
83121
with:
84122
fetch-depth: 2
85123

86-
- name: Check for site changes
124+
- name: Check for site or visualizer changes
87125
id: check_changes
88126
run: |
89127
SITE_CHANGES=$(git diff --name-only HEAD^ HEAD -- site/ || true)
90-
if [ -z "$SITE_CHANGES" ]; then
128+
VIZ_CHANGES=$(git diff --name-only HEAD^ HEAD -- ui/ || true)
129+
if [ -z "$SITE_CHANGES" ] && [ -z "$VIZ_CHANGES" ]; then
91130
echo "No changes in site directory"
92131
echo "has_changes=false" >> $GITHUB_OUTPUT
93132
else
@@ -110,6 +149,13 @@ jobs:
110149
working-directory: site
111150
run: yarn install
112151

152+
- name: 👁️ Unpack visualizer
153+
if: steps.check_changes.outputs.has_changes == 'true'
154+
uses: actions/download-artifact@v4
155+
with:
156+
name: visualizer
157+
path: site/static/visualizer
158+
113159
- name: 🏗️ Build Docusaurus site
114160
if: steps.check_changes.outputs.has_changes == 'true'
115161
working-directory: site

site/sidebars.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ const sidebars: SidebarsConfig = {
3434
"development/throughput-simulation",
3535
"development/simulation-demonstration",
3636
"development/cost-estimator",
37+
{
38+
type: "link",
39+
href: "/visualizer",
40+
label: "Visualizer",
41+
},
3742
],
3843
},
3944
],

0 commit comments

Comments
 (0)