Repository navigation
Fix course pages that render incorrectly - #3287
Open
cindykrafft wants to merge 1 commit into
Open
cindykrafft wants to merge 1 commit into
cindykrafft wants to merge 1 commit into
Conversation
- Escape HTML in mdbook-course outline tables, so titles like
`Box<T>` and `Pin<Ptr>` are no longer shown as "Box" and "Pin".
- Use the full course name in `{{%course outline Unsafe Deep Dive}}`;
the page currently shows "not found".
- Add the missing `<details>` in the safety-preconditions references
slide and fix a `</detail>` typo in the Chromium GN slide.
- Quote `MaybeUninit<T>` so the heading and notes render the `<T>`.
- Remove leftover ANCHOR comments from the modules solution and two
includes of anchors that don't exist in references/exercise.rs.
- Point the installation-instructions link at the README's Setup
section.
Claude-Session: https://claude.ai/code/session_01X59fWmqnA4Nmb9rggkTP7n
This branch has not been deployed
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.
A few pages don't render the way their source intends. I found most of these through
mdbook buildwarnings, and I checked each one in a local build (mdbook 0.5.3, the version pinned in MODULE.bazel) before and after the change.Box<T>renders as "Box" in the Smart Pointers outline, andPin<Ptr>as "Pin" in the Pinning outline (mdbook warns "unclosed HTML tag<t>").Table::add_rownow escapes&,<and>. I added a unit test, andcargo test -p mdbook-coursepasses.{{%course outline Unsafe}}renders as "not found - {{%course outline Unsafe}}" on the published page. The course is namedUnsafe Deep Divein unsafe-deep-dive/welcome.md, andfind_coursecompares names exactly, so the directive now uses the full name.</details>but never opens one, so the speaker notes and the suggested solution show on the slide. I added<details>after the first code block. Could you check that this is where the notes are meant to start?</detail>→</details>.MaybeUninit<T>outside backticks renders as "MaybeUninit". Now in backticks.// ANCHOR:/// ANCHOR_END:lines. They are in plain code blocks, so they show on the page, and exercise.rs no longer defines those anchors.{{#include exercise.rs:magnitude}}and{{#include exercise.rs:normalize}}. exercise.rs has no such anchors, so they render as empty lines.#building, but the README has no such heading. It now points at#setup.After this change the only
mdbook buildwarning left is the one in unsafe-deep-dive/pinning.md, which #3284 fixes.mdbook testanddprint checkpass.