walkthrough
Walkthrough
Explain the code in one pass, from the start of the story to the end. A snippet typed from memory is a miss. Commentary, then a command that prints the file, then the output that command produced.
Pass
-
Read, then plan. Read the source. Plan one order a reader can follow from beginning to end, starting at the foundation or the entry point and moving outward. If the user named a file or an area, stay inside it.
-
Learn the tool. Run
uvx showboat --helpand use what it prints. -
Write
walkthrough.mdat the repo root. If that file already exists, ask before replacing it. Create it withuvx showboat init. -
Alternate notes and printed code. Commentary goes in with
uvx showboat note. Every snippet is auvx showboat execofsed,grep,cat,find, orwcthat prints the bytes on disk. A hand-copied snippet does not go in the note. -
Fix a bad command in the document. If an exec fails or prints the wrong lines,
uvx showboat popthat entry and run the corrected command. -
Check. Run
uvx showboat verify walkthrough.md. In the reply, give the path to the document.