Skip to content
Guided Review
Documentation

Reading the overlay

A map of the Guided Review UI once a review is open — so the sidebar, context column, and header stop feeling like three unrelated panels. Hands-on start: Your first review (extension) or CLI. How units are built: How a review plan works.

Layout

Left to right (desktop):

  1. Sidebar — ordered list of review units for this walkthrough.
  2. Context panel — title, guidance, errors, provider prompts, and the shortcut cheat sheet.
  3. Diff pane — the real hunks (or image / binary empty state) for the active unit.

The header sits above: PR or local scope title, add/delete stats, and primary actions. The footer moves previous / next unit.

Keyboard chords for the same surfaces: Keyboard shortcuts.

Change summary and PR description

The first display step is synthetic — not an LLM unit:

HostFirst step titleWhat it shows
Chrome extensionPR DescriptionPR title and body from the page
CLIChange summaryLocal scope context; Structure With AI lives here

On the CLI, the walkthrough starts one unit per file until you structure it. Structure With AI on the Change summary card (or ⌘/Ctrl + I) is the opt-in annotate call — CLI → Follow the Walkthrough.

Review units sidebar

Labeled Review Units. Each row is a step: number, title, and optionally a flask icon when the unit is a tests step (production and tests stay separate — How a review plan works).

  • Click a row to jump.
  • / move previous / next; the active row stays scrolled into view.
  • While a plan is still streaming, skeleton rows may trail completed units.

Without a provider, titles are mostly file paths. With AI, titles and short guidance come from the model — take them with a grain of salt (FAQ).

Context panel

For the active unit the panel shows:

  • Unit title and commentary (empty on the no-provider file-per-unit fallback until you connect a key).
  • Connect AI Provider / Structure With AI prompts when the walkthrough is still file-by-file or the CLI needs a key.
  • Errors with a Retry when annotate or fetch failed.
  • The same shortcut list as the docs page, always available while the overlay is open.

On the PR description / Change summary step, the panel explains that unit instead of review commentary.

Diff pane

Hunks for the files claimed by the active unit, mapped from the real parsed diff — the model never supplies those lines (invariant).

  • Default view is split; toggle with v then u / s, or the toolbar. The extension remembers the choice.
  • Search (⌘/Ctrl + F) jumps to the unit that owns a match.
  • Comment mode (c) puts a line cursor on selectable lines in this pane.

Header actions

ControlExtensionCLI
Primary buttonSubmit Review (⌘/Ctrl + Enter)Generate Prompt (needs at least one note)
SettingsOptions page (outside overlay)Settings (⌘/Ctrl + ,)
ScopeDiff-scope dropdown (d)
ExitConfirm, then closeConfirm; session ends with the server

Submit needs GitHub connected. Generate Prompt details: Generate Prompt.

Next. Your first review · Images & binary files · Leave line comments · Keyboard shortcuts