Skip to content

docs: 📝 Add questions to check understanding to each section - #230

Merged
ShisatoYano merged 1 commit into
mainfrom
docs/check-understanding
Nov 14, 2026
Merged

ShisatoYano merged 1 commit into
mainfrom
docs/check-understanding

Conversation

@ShisatoYano

Copy link
Copy Markdown
Owner

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 Exercises
  • doc/path_tracking/stanley.md: add three questions, since the Stanley section is the guide's example

Part 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 doc passes, 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

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>
@ShisatoYano ShisatoYano added the documentation Improvements or additions to documentation label Nov 14, 2026
@ShisatoYano ShisatoYano self-assigned this Nov 14, 2026
@ShisatoYano
ShisatoYano merged commit 15ffd3f into main Nov 14, 2026
5 checks passed
@ShisatoYano
ShisatoYano deleted the docs/check-understanding branch November 14, 2026 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant