Rewrite speaker note system · google/comprehensive-rust#1232

2023-09-22T08:17:02.000Z

The [`speaker-notes.js`](https://github.com/google/comprehensive-rust/blob/main/theme/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

(1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Rust (32.954 Stars) (2.009 Forks)batch import

good first issuehelp wanted

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

Tech Stack: javascript
Domain: documentationinternationalizationlocalization
Issue Type: refactor
Schwierigkeit: 3
Geschätzte Zeit: 3-5 days
Aktivitätsstatus: stale
Klarheit: clear
Voraussetzungen: familiarity with speaker notes.jsJavaScript knowledge
Einsteigerfreundlichkeit: 60
Research-Richtung: 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.