google/comprehensive-rust

Formalize patching of `book.js`

Open

#2,924 opened on Sep 23, 2025

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (2,009 forks)batch import
buggood first issue

Repository metrics

Stars
 (32,954 stars)
PR merge metrics
 (Avg merge 9d 23h) (36 merged PRs in 30d)

Description

Inspired by #2571 and other similar changes I made myself, we need to come up with a proper system for maintaining our customizations to theme/book.js. That is, we need to store our modifications as patches or something very similar. Right now, our customizations are direct edits to the file.

The problem is that mdbook is somewhat coupled to it's theme: when we update mdbook to a new version, we run the risk of messing up the rendering if we don't update our (partial!) copy of the default theme.

I'm imagining a system where we:

  1. Store the modifications as a set of patches.
  2. Check that theme/book.js is truly equal to the original book.js file plus the applied patches in a GitHub action.
  3. Some script which can update our mdbook version by updating the book.js file.

I'm probably missing some steps here! 😄

Cc @djmitche, @gribozavr.

Contributor guide

Research direction
Explore existing patch systems (e.g., git patches, quilt) and design a GitHub action to verify that theme/book.js matches the original plus patches. Consider scripting for updating mdbook version.
Tech stack
rustjavascript
Domain
developer experiencedocumentation
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50