Plannotator Guide

A guided review is a reading order for a changeset. Instead of a flat file list, the reader gets chapters. Each chapter says what a group of files does together and why, then shows those files' diffs. The result is one HTML file anyone can open in a browser.

Your job is the thinking: read the diff, understand it, write the guide. The CLI validates the guide, adds provenance, and writes the HTML.

1. Save the diff

Decide what the guide covers, then save exactly that diff:

git diff origin/main...HEAD > guide.patch    # a branch, since it forked
git diff HEAD > guide.patch                  # uncommitted work
git show --format= <sha> > guide.patch       # one commit

For a PR, check it out (gh pr checkout <n>) and diff against its base branch. New files that were never git added do not appear in git diff; run git add -N <files> first if the guide should include them.

2. Write the guide