You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: apps/marketing/src/content/docs/commands/code-review.md
+29-17Lines changed: 29 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
---
2
2
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."
4
4
sidebar:
5
5
order: 11
6
6
section: "Commands"
7
7
---
8
8
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.
10
10
11
11
## Usage
12
12
13
-
**Review uncommitted changes:**
13
+
**Review local changes:**
14
14
15
15
```
16
16
/plannotator-review
@@ -33,7 +33,7 @@ User runs /plannotator-review
33
33
↓
34
34
Agent runs: plannotator review
35
35
↓
36
-
git diff captures unstaged changes
36
+
git diff captures changes
37
37
↓
38
38
Review server starts, opens browser with diff viewer
39
39
↓
@@ -60,14 +60,26 @@ Send Feedback → PR context included in feedback
60
60
Approve → "LGTM" sent to agent
61
61
```
62
62
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
+
63
75
## The diff viewer
64
76
65
77
The review UI shows your changes in a familiar diff format:
66
78
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)
71
83
72
84
## Annotating code
73
85
@@ -81,25 +93,25 @@ When an AI provider is available, the diff viewer includes inline AI chat. Selec
81
93
82
94
Plannotator supports multiple AI providers. Providers are auto-detected based on which CLI tools are installed on your system:
83
95
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))
88
100
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).
90
102
91
103
### Choosing a provider
92
104
93
105
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.
94
106
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.
96
108
97
109
## Submitting feedback
98
110
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
101
113
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.
0 commit comments