google/comprehensive-rust

Make "Speaker Notes" translatable

Open

#1,390 opened on Oct 19, 2023

View on GitHub
 (9 comments) (1 reaction) (0 assignees)Rust (32,954 stars) (2,009 forks)batch import
buggood first issuehelp wanted

Description

The "Speaker Notes" string is currently hard-coded in the JavaScript code that injects it:

https://github.com/google/comprehensive-rust/blob/e9c61b91c19190612f87db8082e70f7a84bdd9ef/theme/speaker-notes.js#L100

There are several other strings in that file that need translation too.

Contributor guide

Tech stack
javascript
Domain
internationalizationlocalization
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
JavaScriptInternationalization basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue is to make the 'Speaker Notes' string and other hard coded strings in `theme/speaker notes.js` translatable. Look at line 100 in that file where the string is injected. Check if the project already uses an i18n library (like i18next) or a custom translation function. Replace each hard coded string with a call to a translation function, and ensure the translation keys are properly defined in a locale file if needed. Also, review other strings in the same file that need similar treatment.