google/comprehensive-rust

Rewrite speaker note system

开放

#1,232 创建于 2023年9月22日

在 GitHub 查看贡献者指南
 (1 条评论) (0 个反应) (0 位负责人)Rust (2,009 个派生)batch import
good first issuehelp wanted

仓库指标

星标
 (32,954 个星标)
PR 合并指标
 (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