google/comprehensive-rust

Rewrite speaker note system

Open

#1.232 geöffnet am 22. Sept. 2023

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Rust (2.009 Forks)batch import
good first issuehelp wanted

Repository-Metriken

Stars
 (32.954 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 9T 23h) (36 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuchen Sie die aktuelle Implementierung von speaker notes.js, verstehen Sie, wie es Sprechernotizen einfügt, und entwerfen Sie dann einen modularen Ersatz, der die Codegröße reduziert, Beschriftungen übersetzbar macht (mithilfe von mdbook i18n helpers, wenn verfügbar) und optional eine Zustandsverwaltungsbibliothek verwendet. Konzentrieren Sie sich darauf, die DOM Manipulation zur Laufzeit zu minimieren.
Tech Stack
javascript
Domain
frontend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
4
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScriptDOM manipulation
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40