Skip to content
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.

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

update to mdbook-0.4.44 and sync book.js and index.hbs #2610

Merged
merged 1 commit into from
Feb 7, 2025

Conversation

michael-kerscher
Copy link
Collaborator

@michael-kerscher michael-kerscher commented Jan 31, 2025

mdbook in CI pipeline is updated to mdbook-0.4.44

  • reran mdbook init --theme
  • keep playground improvements
  • keep language selector and suggest edit / edit to translation button text
  • improvement: toc is in separate js file, makes html file way smaller
  • additionally updated to mdbook-i18n-helpers-0.3.5

relevant upstream changes that are used:

@michael-kerscher
Copy link
Collaborator Author

michael-kerscher commented Feb 4, 2025

This is more difficult and needs some additional work. Cargo install --locked does not use the Cargo.lock from this repository but the one of the lastest version of the crate - so this is not what we want (for now).

There will be a separate work item (#2620) for creating an install script with locked versions to replicate what we have in the CI environment so developers can use the same versions. Then we can update the install script and update everything.

@michael-kerscher michael-kerscher marked this pull request as draft February 4, 2025 09:34
  - reran mdbook init --theme
  - keep playground improvements
  - keep language selector and suggest edit / edit to translation button text
  - improvement: toc is in separate js file, makes html file way smaller
  - additionally updated to mdbook-i18n-helpers-0.3.5

relevant upstream changes that are used:
- rust-lang/mdBook#2414
- rust-lang/mdBook#2421
- rust-lang/mdBook#2454
- rust-lang/mdBook#2463
@michael-kerscher michael-kerscher marked this pull request as ready for review February 5, 2025 14:56
@michael-kerscher
Copy link
Collaborator Author

The output of the updated versions looks good to me and is ready for a review.

@djmitche djmitche self-requested a review February 6, 2025 15:27
@djmitche
Copy link
Collaborator

djmitche commented Feb 6, 2025

Tested this myself and it seems to be in good shape!

This doen't fix the issue of the speaker notes "reverting" to show the slides themselves, but we can address that separately.

@michael-kerscher michael-kerscher merged commit af6dff5 into google:main Feb 7, 2025
35 checks passed
@michael-kerscher michael-kerscher deleted the mdbook-update branch February 7, 2025 09:54
michael-kerscher added a commit to michael-kerscher/comprehensive-rust that referenced this pull request Feb 7, 2025
mdbook in CI pipeline is updated to mdbook-0.4.44
  - reran mdbook init --theme
  - keep playground improvements
- keep language selector and suggest edit / edit to translation button
text
  - improvement: toc is in separate js file, makes html file way smaller
  - additionally updated to mdbook-i18n-helpers-0.3.5

relevant upstream changes that are used:
- rust-lang/mdBook#2414
- rust-lang/mdBook#2421
- rust-lang/mdBook#2454
- rust-lang/mdBook#2463
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants