Skip to content

Commit 8a1959b

Browse files
committed
ci: Document building the docs locally
It was slightly less than obvious. Signed-off-by: Colin Walters <[email protected]>
1 parent 89635a8 commit 8a1959b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

.github/workflows/docs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ concurrency:
1414
group: "pages"
1515
cancel-in-progress: false
1616

17+
# To build the docs locally you can also do e.g.:
18+
# cargo install mdbook-mermaid
19+
# cd docs
20+
# mdbook-mermaid install
21+
# mdbook serve
22+
1723
jobs:
1824
build:
1925
runs-on: ubuntu-latest

0 commit comments

Comments
 (0)