Code Walkthrough

Generate a structured, linear walkthrough of a codebase (or a single file) using Showboat. The output is a markdown document meant to be read top-to-bottom in one sitting — a single narrative thread that builds understanding incrementally, not a reference manual you jump around in.

What "linear" means: The agent decides on a teaching sequence and the reader follows it from beginning to end. This is deliberately different from API docs (jump to what you need), READMEs (overview), code comments (scattered inline), or wiki pages (interlinked, no single path). A linear walkthrough has a beginning, middle, and end — like a guided tour where the guide chooses the route.

The walkthrough mixes narrative explanation with real code snippets extracted via shell commands — never from memory.

Why Showboat

The agent writes showboat exec demo.md bash "cat src/main.py | head -30" instead of pasting code from its context window. The document contains executed output, not recalled content. This eliminates hallucination risk entirely — every snippet is ground truth from the filesystem.

Showboat also supports showboat verify to re-run all code blocks and diff against recorded output — making walkthroughs reproducible proof of work, not just documentation.

Prerequisites

Showboat must be installed. Check with showboat --version. If missing:

uv tool install showboat