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 (2 009 forks)batch import
good first issuehelp wanted

Métriques du dépôt

Stars
 (32 954 stars)
Métriques de merge PR
 (Merge moyen 9j 23h) (36 PRs mergées en 30 j)

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

Direction de recherche
Examinez l'implémentation actuelle de speaker notes.js, comprenez comment il injecte les notes du présentateur, puis concevez un remplacement modulaire qui réduit la taille du code, rend les étiquettes traduisibles (en utilisant mdbook i18n helpers quand il sera disponible) et éventuellement utilise une bibliothèque de gestion d'état. Concentrez vous sur la minimisation de la manipulation du DOM à l'exécution.
Stack technique
javascript
Domaine
frontend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaScriptDOM manipulation
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40