From 908d1dcf75bed84110415ec6d1eb230b40cec45e Mon Sep 17 00:00:00 2001 From: Antonio Draudy Date: Sat, 7 Mar 2026 12:14:31 +0200 Subject: [PATCH 1/2] Added note about dependency version numbers into the build guide Added a link to the deploy script as the authoritative source for those version numbers, so they don't have to be separately maintained in the docs. --- src/en/meta/guide-to-editing-docs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/en/meta/guide-to-editing-docs.md b/src/en/meta/guide-to-editing-docs.md index 8577d1c018..4c7f0e58c9 100644 --- a/src/en/meta/guide-to-editing-docs.md +++ b/src/en/meta/guide-to-editing-docs.md @@ -32,7 +32,7 @@ If you just want to make a basic edit of a page, simply follow these steps--you ## Building -If you want to locally build the docs, the necessary dependencies are Rust and some binaries installed using `cargo`. It's recommended that you use `cargo install` or `cargo quickinstall`, as building can take a while. +If you want to locally build the docs, you need to install Rust, then install the project dependencies using `cargo`. It's recommended that you use `cargo install` or `cargo quickinstall`, as building can take a while. Because the project doesn't use the latest versions of these crates, you need to specify the correct version number, for example: `cargo install mdbook@0.4.36`. You can find the versions currently in use from [the deploy script](https://github.com/WizAntonioD/ss14-docs/blob/master/.github/workflows/deploy.yml) and the versions you have installed with `cargo install --list`. From cargo, install: - `mdbook` @@ -43,7 +43,7 @@ From cargo, install: - `mdbook-mermaid` - `mdbook-template` -Run `mdbook serve` to build and locally host the documentation from the `book` directory at `localhost:3000`. +Run `mdbook serve` to build and locally host the documentation at `localhost:3000`. ## Testing changes From ff2b42ee9f4227ebefaf48694127898264211352 Mon Sep 17 00:00:00 2001 From: Antonio Draudy Date: Sat, 7 Mar 2026 12:22:09 +0200 Subject: [PATCH 2/2] Fixed the link to point to space-wizards/docs --- src/en/meta/guide-to-editing-docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/en/meta/guide-to-editing-docs.md b/src/en/meta/guide-to-editing-docs.md index 4c7f0e58c9..7de9348143 100644 --- a/src/en/meta/guide-to-editing-docs.md +++ b/src/en/meta/guide-to-editing-docs.md @@ -32,7 +32,7 @@ If you just want to make a basic edit of a page, simply follow these steps--you ## Building -If you want to locally build the docs, you need to install Rust, then install the project dependencies using `cargo`. It's recommended that you use `cargo install` or `cargo quickinstall`, as building can take a while. Because the project doesn't use the latest versions of these crates, you need to specify the correct version number, for example: `cargo install mdbook@0.4.36`. You can find the versions currently in use from [the deploy script](https://github.com/WizAntonioD/ss14-docs/blob/master/.github/workflows/deploy.yml) and the versions you have installed with `cargo install --list`. +If you want to locally build the docs, you need to install Rust, then install the project dependencies using `cargo`. It's recommended that you use `cargo install` or `cargo quickinstall`, as building can take a while. Because the project doesn't use the latest versions of these crates, you need to specify the correct version number, for example: `cargo install mdbook@0.4.36`. You can find the versions currently in use from [the deploy script](https://github.com/space-wizards/docs/blob/master/.github/workflows/deploy.yml) and the versions you have installed with `cargo install --list`. From cargo, install: - `mdbook`