From a4f04cfa7e3d780e56e264c0045e74fce785fcae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Onur=20=C3=96zkan?= Date: Sun, 9 Aug 2026 14:29:12 +0300 Subject: [PATCH] build: provide mdBook in Nix shell --- .github/workflows/docs.yml | 2 +- docs/src/getting-started.md | 6 +++--- flake.nix | 1 + 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ee3ea39..f0dc630 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -33,7 +33,7 @@ jobs: uses: actions/configure-pages@v5 - name: Install mdBook - run: cargo install mdbook --version 0.5.2 --locked + run: cargo install mdbook --version 0.5.3 --locked - name: Build the site run: mdbook build docs diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md index 7cf4576..046ee2e 100644 --- a/docs/src/getting-started.md +++ b/docs/src/getting-started.md @@ -30,11 +30,11 @@ Do not add board-local READMEs. Add a page here instead, then link it from ## Build the documentation website -The manual is an [mdBook](https://rust-lang.github.io/mdBook/) project. Build -it locally with a compatible `mdbook` binary: +The manual is an [mdBook](https://rust-lang.github.io/mdBook/) project. The +repository's Nix development shell provides the checked tool version: ```sh -make -C docs build +nix develop -c make -C docs build ``` The generated static site is written to `target/docs/`. The GitHub Pages diff --git a/flake.nix b/flake.nix index 6f4eea2..315bac2 100644 --- a/flake.nix +++ b/flake.nix @@ -25,6 +25,7 @@ packages = [ pkgs.rustup pkgs.dfu-util + pkgs.mdbook python ]; };