Skip to content

Added info about dependency version numbers into the build guide #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
WizAntonioD wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added info about dependency version numbers into the build guide #610

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
908d1dc
Added note about dependency version numbers into the build guide
WizAntonioD Mar 7, 2026
ff2b42e
Fixed the link to point to space-wizards/docs
WizAntonioD Mar 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/en/meta/guide-to-editing-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/space-wizards/docs/blob/master/.github/workflows/deploy.yml) and the versions you have installed with `cargo install --list`.

From cargo, install:
- `mdbook`
Expand All @@ -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

Expand Down