google/comprehensive-rust

Rewrite speaker note system

Open

#1,232 建立於 2023年9月22日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Rust (2,009 fork)batch import
good first issuehelp wanted

倉庫指標

Star
 (32,954 star)
PR 合併指標
 (平均合併 9天 23小時) (30 天內合併 36 個 PR)

描述

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

貢獻者指南

研究方向
檢查當前的 speaker notes.js 實現，了解它是如何注入演講者筆記的，然後設計一個模塊化的替代方案，以減少代碼大小、使標籤可翻譯（在 mdbook i18n helpers 可用時使用），並可選地使用狀態管理庫。重點是最小化運行時 DOM 操作。
技術棧
javascript
領域
frontend
議題類型
重構
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
4
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
JavaScriptDOM manipulation
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40