google/comprehensive-rust

Formalize patching of `book.js`

Open

#2924 aperta il 23 set 2025

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)Rust (2009 fork)batch import
buggood first issue

Metriche repository

Star
 (32.954 star)
Metriche merge PR
 (Merge medio 9g 23h) (36 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esplora i sistemi di patch esistenti (ad esempio, git patch, quilt) e progetta un'azione GitHub per verificare che theme/book.js corrisponda all'originale più le patch. Considera di scrivere uno script per aggiornare la versione di mdbook.
Tech stack
rustjavascript
Dominio
developer experiencedocumentation
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50