Skip to content
Guided Review
Documentation

Your first review

From a normal GitHub PR page to a structured walkthrough in a few clicks. If the extension isn’t installed yet, start with Install.

Open a pull request

Navigate to any pull request on github.com (Conversation, Files changed, or Commits). The content script is injected on https://github.com/* so SPA navigation from the PR list still shows the button when you land on a PR.

No button? See Troubleshooting.

Start Guided Review

  1. Click Start Guided Review on the PR page.
  2. The overlay opens in a Shadow DOM host so its styles don’t fight GitHub’s CSS.
  3. The extension fetches the PR diff, builds a prompt, and streams a review plan from your configured provider.
  4. Units appear progressively as the stream completes each chunk; the final merged plan is what you step through.
Note

No provider configured? You’ll be prompted to open Options and add an API key first. Connection failures: Troubleshooting.

Walk the plan

The overlay shows display units in order: a synthetic PR description step first, then each planned unit. How units are built and validated is covered in How a review plan works.

For each unit you can:

  • Read the unit’s title and guidance (take summaries with a grain of salt — see the FAQ)
  • See the linked hunks from the real diff (unified or split — v u / v s, or the toolbar)
  • Move next / previous with the footer or keyboard shortcuts

The model chooses order and commentary; it does not supply the code lines you see. Hunk ids that don’t match the parsed diff are dropped.

Leave comments and submit

As you walk:

  1. Press c to enter comment mode, select lines, and draft line comments. Drafts stay local until you submit (privacy).
  2. When you’re ready, press ⌘/Ctrl + Enter (or use Submit review) to choose Comment / Approve / Request Changes and send the review.

Submit needs GitHub connected. Walking the plan and drafting do not. Full shortcut list: Keyboard shortcuts.

Resume later

Sessions (diff, plan, PR context, current step, drafts) are stored in chrome.storage.session, keyed by owner/repo#number — not the full URL — so you can switch between Conversation and Files changed tabs and resume the same plan until the browser session ends. Limits and clears: Troubleshooting.

If something fails mid-flight, see Troubleshooting.