google/comprehensive-rust

Rewrite speaker note system

Open

#1 232 ouverte le 22 sept. 2023

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)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

Guide contributeur

Stack technique
javascript
Domaine
documentationinternationalizationlocalization
Type d'issue
refactor
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
familiarity with speaker notes.jsJavaScript knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.