google/comprehensive-rust

Formalize patching of `book.js`

Open

#2.924 geöffnet am 23. Sept. 2025

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (2.009 Forks)batch import
buggood first issue

Repository-Metriken

Stars
 (32.954 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 9T 23h) (36 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Erkunde bestehende Patch Systeme (z. B. Git Patches, Quilt) und entwerfe eine GitHub Aktion, um zu überprüfen, ob theme/book.js mit dem Original plus den Patches übereinstimmt. Erwäge ein Skript zum Aktualisieren der mdbook Version.
Tech Stack
rustjavascript
Domain
developer experiencedocumentation
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50