google/comprehensive-rust

Rewrite speaker note system

Open

#1.232 aberto em 22 de set. de 2023

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (32.954 stars) (2.009 forks)batch import
good first issuehelp wanted

Description

The speaker-notes.js file is a little home-grown system for injecting speaker notes to the pages.

I would like to rewrite this to use a more modern development style:

  • we should minimize the code when publishing the course
  • we should make the label ("Speaker Notes") translatable!
  • we could perhaps use a library for some of the state logic?
  • we could take advantage of https://github.com/google/mdbook-i18n-helpers/issues/70 when it's ready to do less on the fly DOM manipulation

Guia do colaborador

Pilha de tecnologia
javascript
Domain
documentationinternationalizationlocalization
Tipo Issue
refactor
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.
3-5 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
familiarity with speaker notes.jsJavaScript knowledge
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
Start by reading the current speaker notes.js file to understand the existing DOM manipulation and state logic. Investigate the linked mdbook i18n helpers issue #70 for planned features that could simplify the rewrite. Look into lightweight JavaScript libraries for state management that would minimize code size. Ensure the new system supports making the 'Speaker Notes' label translatable, likely by integrating with the i18n helpers.