google/comprehensive-rust

Rewrite speaker note system

Open

#1232 aperta il 22 set 2023

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Rust (2009 fork)batch import
good first issuehelp wanted

Metriche repository

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

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina l'implementazione corrente di speaker notes.js, comprendi come inietta le note del relatore, quindi progetta un sostituto modulare che riduca le dimensioni del codice, renda le etichette traducibili (usando mdbook i18n helpers quando disponibile) e opzionalmente utilizzi una libreria di gestione dello stato. Concentrati sulla minimizzazione della manipolazione del DOM in fase di esecuzione.
Tech stack
javascript
Dominio
frontend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
4
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JavaScriptDOM manipulation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40