google/comprehensive-rust

Rewrite speaker note system

Open

#1,232 opened on Sep 22, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (2,009 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (32,954 stars)
PR merge metrics
 (Avg merge 9d 23h) (36 merged PRs in 30d)

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

Contributor guide

Research direction
Examine the current speaker notes.js implementation, understand how it injects speaker notes, then design a modular replacement that reduces code size, makes labels translatable (using mdbook i18n helpers when available), and optionally uses a state management library. Focus on minimizing runtime DOM manipulation.
Tech stack
javascript
Domain
frontend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptDOM manipulation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40