google / google/comprehensive-rust
Rewrite speaker note system
Open
good first issue
help wanted
- Dominant language
- Rust
- Stars
- 33.4k
- Forks
- 2.1k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 10
Description
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
Contributor guide
Assessment
This issue has not been assessed yet.