Skip to content

Commit 6ab9858

Browse files
authored
Add speaker notes to instructor-focused slides (#2899)
Following the style guide, these notes provide additional context for instructors and self-learners. The notes focus on practical tips for running the course and highlighting key information for students.
1 parent 766d8df commit 6ab9858

File tree

3 files changed

+50
-0
lines changed

3 files changed

+50
-0
lines changed

src/running-the-course.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,29 @@ better. Your students are also very welcome to [send us feedback][2]!
5555
[1]: https://github.com/google/comprehensive-rust/discussions/86
5656
[2]: https://github.com/google/comprehensive-rust/discussions/100
5757
[3]: https://github.com/google/comprehensive-rust#building
58+
59+
<details>
60+
61+
### Instructor Preparation
62+
63+
- **Go through all the material:** Before teaching the course, make sure you
64+
have gone through all the slides and exercises yourself. This will help you
65+
anticipate questions and potential difficulties.
66+
- **Prepare for live coding:** The course involves a lot of live coding.
67+
Practice the examples and exercises beforehand to ensure you can type them out
68+
smoothly during the class. Have the solutions ready in case you get stuck.
69+
- **Familiarize yourself with `mdbook`:** The course is presented using
70+
`mdbook`. Knowing how to navigate, search, and use its features will make the
71+
presentation smoother.
72+
73+
### Creating a Good Learning Environment
74+
75+
- **Encourage questions:** Reiterate that there are no "stupid" questions. A
76+
welcoming atmosphere for questions is crucial for learning.
77+
- **Manage time effectively:** Keep an eye on the schedule, but be flexible.
78+
It's more important that students understand the concepts than sticking
79+
rigidly to the timeline.
80+
- **Facilitate group work:** During exercises, encourage students to work
81+
together. This can help them learn from each other and feel less stuck.
82+
83+
</details>

src/running-the-course/keyboard-shortcuts.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,15 @@ There are several useful keyboard shortcuts in mdBook:
66
- <kbd>Arrow-Right</kbd>: Navigate to the next page.
77
- <kbd>Ctrl + Enter</kbd>: Execute the code sample that has focus.
88
- <kbd>s</kbd>: Activate the search bar.
9+
10+
<details>
11+
12+
- Mention that these shortcuts are standard for `mdbook` and can be useful when
13+
navigating any `mdbook`-generated site.
14+
- You can demonstrate each shortcut live to the students.
15+
- The <kbd>s</kbd> key for search is particularly useful for quickly finding
16+
topics that have been discussed earlier.
17+
- <kbd>Ctrl + Enter</kbd> will be super important for you since you'll do a lot
18+
of live coding.
19+
20+
</details>

src/running-the-course/translations.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,15 @@ get going. Translations are coordinated on the [issue tracker].
9797
[synced-translation-report]: https://google.github.io/comprehensive-rust/synced-translation-report.html
9898
[our instructions]: https://github.com/google/comprehensive-rust/blob/main/TRANSLATIONS.md
9999
[issue tracker]: https://github.com/google/comprehensive-rust/issues/282
100+
101+
<details>
102+
103+
- This is a good opportunity to thank the volunteers who have contributed to the
104+
translations.
105+
- If there are students in the class who speak any of the listed languages, you
106+
can encourage them to check out the translated versions and even contribute if
107+
they find any issues.
108+
- Highlight that the project is open source and contributions are welcome, not
109+
just for translations but for the course content itself.
110+
111+
</details>

0 commit comments

Comments
 (0)