google/comprehensive-rust

Formalize patching of `book.js`

Open

#2.924 aberto em 23 de set. de 2025

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (2.009 forks)batch import
buggood first issue

Métricas do repositório

Stars
 (32.954 stars)
Métricas de merge de PR
 (Mesclagem média 9d 23h) (36 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Explore sistemas de patch existentes (por exemplo, git patches, quilt) e projete uma ação do GitHub para verificar se theme/book.js corresponde ao original mais os patches. Considere escrever um script para atualizar a versão do mdbook.
Pilha de tecnologia
rustjavascript
Domain
developer experiencedocumentation
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50