Repository navigation
docs: 📝 Add questions to check understanding to each section - #230
Merged
Merged
Conversation
A reader asked on X for questions at the end of each chapter to check that they understood it. Exercises need the code layer, which waits for the refactoring, but questions answered from the text alone can be written with the theory layer now. The Stanley section, the guide's example, gets three of them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Nov 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
doc/WRITING_GUIDE.md: add Check your understanding as the 5th part of the theory layer (2-3 questions answered from the text alone, with the answers folded in<details>), and add it to the template before Exercisesdoc/path_tracking/stanley.md: add three questions, since the Stanley section is the guide's examplePart of #165. A reader asked for questions at the end of each chapter to check that they understood it. Exercises belong to the code layer and wait for the refactoring, but these questions only need the text, so they can be written with the theory layer now. Sections written before this rule get their questions later (tracked in #165).
How I checked it works
sphinx-build -W --keep-going docpasses, and the answers render folded under each question, with the math inside them.Images
Not needed (the rendered page can be checked in the book build of this PR).
🤖 Generated with Claude Code