google/comprehensive-rust

Add speaker notes to every page

Open

#1,083 opened on Aug 15, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (32,954 stars) (2,009 forks)batch import
enhancementgood first issuehelp wanted

Description

We currently have speaker notes on 165 out of 265 pages.

  • We should aim to add speaker notes on all new pages
  • We should also add notes to all existing pages.

Notes are very helpful for both instructors and people who read the course on their own, so we want to be as complete as possible here.

Contributor guide

Tech stack
rust
Domain
documentationcontent
Issue type
documentation
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.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Rust basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review existing speaker notes in the repository to understand the format and content style. Then identify pages without speaker notes by checking the course material files (likely Markdown files in `src/` directory). Add speaker notes to all missing pages, ensuring they are helpful for both instructors and self learners. Refer to any discussion in the issue comments for additional guidance.