Skip to content

Commit e53e76c

Browse files
authored
docs: document diff type switcher in code review docs (#398)
The review UI supports switching between uncommitted, staged, unstaged, last commit, and branch diffs, but the docs only mentioned uncommitted changes. This led users to think a branch diff view wasn't supported. Closes #397 For provenance purposes, this commit was AI assisted.
1 parent a8260eb commit e53e76c

1 file changed

Lines changed: 29 additions & 17 deletions

File tree

apps/marketing/src/content/docs/commands/code-review.md

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: "Code Review"
3-
description: "The /plannotator-review slash command for reviewing uncommitted code changes or GitHub pull requests."
3+
description: "The /plannotator-review slash command for reviewing local changes, comparing branches, or reviewing GitHub pull requests."
44
sidebar:
55
order: 11
66
section: "Commands"
77
---
88

9-
The `/plannotator-review` command opens an interactive code review UI for your uncommitted changes or a GitHub pull request.
9+
The `/plannotator-review` command opens an interactive code review UI for your local changes or a GitHub pull request.
1010

1111
## Usage
1212

13-
**Review uncommitted changes:**
13+
**Review local changes:**
1414

1515
```
1616
/plannotator-review
@@ -33,7 +33,7 @@ User runs /plannotator-review
3333
3434
Agent runs: plannotator review
3535
36-
git diff captures unstaged changes
36+
git diff captures changes
3737
3838
Review server starts, opens browser with diff viewer
3939
@@ -60,14 +60,26 @@ Send Feedback → PR context included in feedback
6060
Approve → "LGTM" sent to agent
6161
```
6262

63+
## Switching diff types
64+
65+
By default the review opens showing uncommitted changes, but you can switch what you're comparing using the diff type dropdown in the toolbar. The available options are:
66+
67+
- **Uncommitted changes** - everything that differs from HEAD, including untracked files
68+
- **Staged changes** - only what's in the staging area (what `git commit` would include)
69+
- **Unstaged changes** - working tree changes that haven't been staged yet, plus untracked files
70+
- **Last commit** - the diff introduced by the most recent commit
71+
- **vs main** (or your default branch) - all committed changes on your branch compared to the base branch. This gives you the same view you'd see on a pull request, without needing to push or create one. Only appears when you're on a branch other than the default.
72+
73+
If you're working on a feature branch and want to see everything you've done before opening a PR, switch to the "vs main" option. It's a good way to do a self-review of your full branch diff.
74+
6375
## The diff viewer
6476

6577
The review UI shows your changes in a familiar diff format:
6678

67-
- **File tree sidebar** — Navigate between changed files
68-
- **Viewed tracking** — Mark files as viewed to track progress
69-
- **Unified diff** — See additions and deletions in context
70-
- **Annotation tools** — Same annotation types as plan review (delete, replace, comment, insert)
79+
- **File tree sidebar** for navigating between changed files
80+
- **Viewed tracking** to mark files as reviewed and track your progress
81+
- **Unified diff** showing additions and deletions in context
82+
- **Annotation tools** with the same annotation types as plan review (delete, replace, comment, insert)
7183

7284
## Annotating code
7385

@@ -81,25 +93,25 @@ When an AI provider is available, the diff viewer includes inline AI chat. Selec
8193

8294
Plannotator supports multiple AI providers. Providers are auto-detected based on which CLI tools are installed on your system:
8395

84-
- **Claude** — Requires the `claude` CLI ([Claude Code](https://docs.anthropic.com/en/docs/claude-code))
85-
- **Codex** — Requires the `codex` CLI ([OpenAI Codex](https://github.com/openai/codex))
86-
- **Pi** — Requires the `pi` CLI ([Pi](https://github.com/mariozechner/pi-coding-agent))
87-
- **OpenCode** — Requires the `opencode` CLI ([OpenCode](https://opencode.ai))
96+
- **Claude** requires the `claude` CLI ([Claude Code](https://docs.anthropic.com/en/docs/claude-code))
97+
- **Codex** requires the `codex` CLI ([OpenAI Codex](https://github.com/openai/codex))
98+
- **Pi** requires the `pi` CLI ([Pi](https://github.com/mariozechner/pi-coding-agent))
99+
- **OpenCode** requires the `opencode` CLI ([OpenCode](https://opencode.ai))
88100

89-
All providers can be available simultaneously. Plannotator does not manage API keys you must be authenticated with each CLI independently (`claude` uses `~/.claude/` credentials, `codex` uses `OPENAI_API_KEY`, `pi` and `opencode` use their own local configuration).
101+
All providers can be available simultaneously. Plannotator does not manage API keys, so you must be authenticated with each CLI independently (`claude` uses `~/.claude/` credentials, `codex` uses `OPENAI_API_KEY`, `pi` and `opencode` use their own local configuration).
90102

91103
### Choosing a provider
92104

93105
When multiple providers are available, set your default in **Settings → AI**. The AI tab shows all detected providers as selectable cards. Your choice persists across sessions.
94106

95-
If only one provider is installed, it's used automatically no configuration needed.
107+
If only one provider is installed, it's used automatically with no configuration needed.
96108

97109
## Submitting feedback
98110

99-
- **Send Feedback** — Formats your annotations and sends them to the agent
100-
- **Approve** — Sends "LGTM" to the agent, indicating the changes look good
111+
- **Send Feedback** formats your annotations and sends them to the agent
112+
- **Approve** sends "LGTM" to the agent, indicating the changes look good
101113

102-
After submission, the agent receives your feedback and can act on it fixing issues, explaining decisions, or making the requested changes.
114+
After submission, the agent receives your feedback and can act on it, whether that's fixing issues, explaining decisions, or making the requested changes.
103115

104116
## Server API
105117

0 commit comments

Comments
 (0)