Skip to content

Commit e8f9f99

Browse files
nleveeclaude
andcommitted
chore(docs): install mkdocs deps with uv and enable mermaid2 plugin
Switch the docs toolchain from pip to uv, in CI (docs.yaml) and locally via mise.toml (aligned with the worktree-docs-contributing-tools branch). Declare the mermaid2 plugin (with search) in mkdocs.yml so the state machine diagrams actually render. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 22b6776 commit e8f9f99

3 files changed

Lines changed: 41 additions & 1 deletion

File tree

.github/workflows/docs.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ jobs:
2525
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
2626
with:
2727
python-version: 3.x
28+
- uses: astral-sh/setup-uv@11f9893b081a58869d3b5fccaea48c9e9e46f990 # v8.3.2
29+
with:
30+
version: "0.11.19"
2831
- uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5
2932
with:
3033
key: mkdocs-material-${{ github.ref }}
@@ -33,7 +36,7 @@ jobs:
3336
mkdocs-material-
3437
3538
- name: Install dependencies
36-
run: pip install -r requirements.txt
39+
run: uv pip install --system -r requirements.txt
3740

3841
- name: Lint Markdown files
3942
uses: DavidAnson/markdownlint-cli2-action@ce4853d43830c74c1753b39f3cf40f71c2031eb9 # v23

mise.toml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[tools]
2+
# Language runtimes — matched to the Dockerfile build images so dev == build
3+
go = "1.26.3" # Dockerfile golang builder (>= go.mod 1.26.0)
4+
node = "24.16.0" # Dockerfile node builder / ci-frontend NODE_VERSION
5+
yarn = "1.22.22" # classic, matches ui/yarn.lock
6+
7+
# Kubernetes & dev CLIs — pinned for a reproducible environment
8+
kubectl = "1.36.2" # aligns with ENVTEST_K8S_VERSION (1.36.0)
9+
helm = "4.2.0"
10+
kind = "0.32.0"
11+
yq = "4.53.3" # mikefarah
12+
golangci-lint = "2.12.2"
13+
14+
# Docs toolchain
15+
uv = "0.11.19"
16+
17+
# Not managed here (system-level): docker + buildx/compose, make, git.
18+
19+
[env]
20+
# Automatic virtualenv activation for the docs toolchain
21+
_.python.venv = { path = ".venv", create = true }
22+
23+
[tasks.install]
24+
description = "Install documentation dependencies"
25+
run = "uv pip install -r requirements.txt"
26+
27+
[tasks.mkdocs-serve]
28+
depends = "install"
29+
description = "Serve MkDocs documentation locally"
30+
run = "uv run mkdocs serve"
31+
32+
[tasks.lint]
33+
description = "Run golangci-lint (no make target exists for it)"
34+
run = "golangci-lint run ./..."

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ theme:
99
extra:
1010
version:
1111
provider: mike
12+
plugins:
13+
- search
14+
- mermaid2
1215
markdown_extensions:
1316
- codehilite
1417
- admonition

0 commit comments

Comments
 (0)