docs(style): Add mdbook and mdbook-course conventions #2926
Conversation
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
gribozavr
commented
Sep 23, 2025
| - **Outline Helpers:** Pages that serve as an index for a session or segment | ||
| **must** use the `{{%session outline%}}` or `{{%segment outline%}}` helpers. | ||
| - **File Includes:** Code for exercises and their solutions **must** be included | ||
| from external files using the standard `mdbook` `{{#include ...}}` helper. |
Collaborator
Author
There was a problem hiding this comment.
Based on my quick check, it seems like many exercises indeed use the include feature. But do we consider it mandatory or should we soften this rule?
Adds a new section to STYLE.md to document mandatory conventions for using `mdbook` and the custom `mdbook-course` preprocessor. This section mandates the use of YAML frontmatter, outline helpers, and file includes for exercises, and links to the `mdbook-course` README for more detailed technical explanations.
gribozavr
force-pushed
the
docs/mdbook-conventions
branch
from
b15b8b6 to
9f9eafd
Compare
mgeisler
approved these changes
Sep 24, 2025
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.
Adds a new section to STYLE.md to document mandatory conventions for using
mdbookand the custommdbook-coursepreprocessor.This section mandates the use of YAML frontmatter, outline helpers, and file includes for exercises, and links to the
mdbook-courseREADME for more detailed technical explanations.