CI: add mdbook test to validate guide in PRs#2711
Merged
Merged
Conversation
benhillis
commented
Jan 29, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds mdbook test to the CI build process to validate that Rust code examples in the guide compile correctly. It also marks several flowey-related code snippets with rust,ignore to exclude them from compilation testing, and removes a redundant configuration setting from book.toml.
Changes:
- Added
mdbook testcommand to build_guide.rs to validate code examples during guide builds - Marked incomplete code snippets in flowey documentation files with
rust,ignoreattribute - Removed redundant
multilingual = falsesetting from book.toml (it's the default value)
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| flowey/flowey_lib_hvlite/src/build_guide.rs | Added mdbook test command and refactored environment variable setup |
| Guide/src/dev_guide/dev_tools/flowey/variables.md | Marked code snippets with rust,ignore |
| Guide/src/dev_guide/dev_tools/flowey/steps.md | Marked code snippets with rust,ignore |
| Guide/src/dev_guide/dev_tools/flowey/pipelines.md | Marked code snippets with rust,ignore |
| Guide/src/dev_guide/dev_tools/flowey/nodes.md | Marked code snippets with rust,ignore |
| Guide/src/dev_guide/dev_tools/flowey/artifacts.md | Marked code snippets with rust,ignore |
| Guide/book.toml | Removed redundant default configuration value |
mattkur
previously approved these changes
Feb 4, 2026
benhillis
force-pushed
the
mdbook_test
branch
from
79f1295 to
eafcb16
Compare
mattkur
approved these changes
Feb 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This change ensures that code samples in the rust code samples compile and fixes any current issues preventing
mdbook testfrom currently passing.