Skip to content

Commit 9a32022

Browse files
authored
docs: scrub Insert/Replace from docs to match shipped UI (#618)
* docs: scrub Insert/Replace from docs to match shipped UI The annotation toolbar ships with Delete, Comment, Quick label (⚡), Looks good (👍), and Copy. AnnotationType only has DELETION, COMMENT, and GLOBAL_COMMENT. Insertion/Replacement were removed in #400 but several docs still describe them as toolbar options. Updates 9 files (the 7 listed in #617 plus two additional pages with the same drift): - apps/marketing/src/content/docs/getting-started/quickstart.md - apps/marketing/src/content/docs/getting-started/ui-settings.md - apps/marketing/src/content/docs/commands/plan-review.md - apps/marketing/src/content/docs/commands/annotate.md - apps/marketing/src/content/docs/commands/code-review.md - apps/marketing/src/content/blog/welcome.md - apps/marketing/src/content/blog/plannotator-meets-pi.md - apps/marketing/src/content/blog/sharing-plans-with-your-team.md - apps/portal/ANNOTATE.md Where it made sense, added a note that users can ask for replacements or insertions inside a Comment — the agent handles it during revision. Closes #617 * docs: include Looks good (👍) in toolbar enumerations
1 parent 33f409a commit 9a32022

9 files changed

Lines changed: 19 additions & 14 deletions

File tree

apps/marketing/src/content/blog/plannotator-meets-pi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Because the plan lives on disk as a regular file, you can open it in your editor
4949

5050
### Review phase
5151

52-
When the agent calls `plannotator_submit_plan`, the extension reads `PLAN.md` from disk, starts a local HTTP server, and opens the Plannotator browser UI. You see the rendered plan with all the annotation tools — comments, deletions, replacements, insertions.
52+
When the agent calls `plannotator_submit_plan`, the extension reads `PLAN.md` from disk, starts a local HTTP server, and opens the Plannotator browser UI. You see the rendered plan with all the annotation tools — comments, deletions, global comments, quick labels, and "looks good" approvals.
5353

5454
Three outcomes:
5555

apps/marketing/src/content/blog/sharing-plans-with-your-team.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ You paste this in Slack and send it to your senior teammate.
3737
Your senior clicks the link. The share portal — a static page with no backend — decompresses the URL hash and renders the plan with your annotations. They can now add their own feedback:
3838

3939
- **Comment** on the migration script section: "Add a rollback step"
40-
- **Replace** the session handling approach: swap JWT for HTTP-only cookies
40+
- **Comment** on the session handling approach: "Swap JWT for HTTP-only cookies"
4141
- **Delete** the unnecessary logging middleware
42-
- **Insert** a note about rate limiting on the new auth endpoints
42+
- **Quick label** the auth endpoints with "Needs tests" and add a comment: "Document rate limiting here"
4343

4444
Each annotation is tied to the specific text it references.
4545

@@ -49,7 +49,7 @@ Your senior clicks **Export → Copy Link** to share their annotated version bac
4949

5050
### 5. You send combined feedback to Claude
5151

52-
With the merged annotations in front of you, you click **Request Changes**. Plannotator formats the combined feedback — deletions, replacements, comments, insertions — into structured markdown and sends it back to Claude Code through the hook system. Claude receives specific, actionable feedback and revises the plan.
52+
With the merged annotations in front of you, you click **Request Changes**. Plannotator formats the combined feedback — deletions, comments, global comments, quick labels, and "looks good" approvals — into structured markdown and sends it back to Claude Code through the hook system. Claude receives specific, actionable feedback and revises the plan.
5353

5454
## How the hook integration works
5555

apps/marketing/src/content/blog/welcome.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Plannotator is a plan review UI for Claude Code that intercepts `ExitPlanMode` v
1414

1515
## What is Plannotator?
1616

17-
When Claude Code generates a plan, Plannotator opens an interactive review UI in your browser. You can read through the plan, select text to annotate, and provide structured feedback — deletions, replacements, comments, and insertions — before approving or requesting changes.
17+
When Claude Code generates a plan, Plannotator opens an interactive review UI in your browser. You can read through the plan, select text to annotate, and provide structured feedback — deletions, comments, global comments, quick labels, and "looks good" approvals — before approving or requesting changes.
1818

1919
## Key Features
2020

apps/marketing/src/content/docs/commands/annotate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The annotation UI in annotate mode works the same as plan review, with a few cha
9999
- `Cmd/Ctrl+Enter` sends annotations instead of approving
100100
- The completion screen says "Annotations Sent" instead of "Plan Approved"
101101

102-
All annotation types work identically: deletions, replacements, comments, insertions, global comments, and image attachments.
102+
All annotation types work identically: deletions, comments, global comments, quick labels, "looks good" approvals, and image attachments.
103103

104104
## Flags
105105

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ The review UI shows your changes in a familiar diff format:
7979
- **File tree sidebar** for navigating between changed files
8080
- **Viewed tracking** to mark files as reviewed and track your progress
8181
- **Unified diff** showing additions and deletions in context
82-
- **Annotation tools** with the same annotation types as plan review (delete, replace, comment, insert)
82+
- **Annotation tools** with the same annotation types as plan review (delete, comment, quick label, "looks good")
8383

8484
## Annotating code
8585

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,13 @@ When you select text in the plan, the annotation toolbar appears with these opti
3636
| Type | What it does | Example |
3737
|------|-------------|---------|
3838
| **Deletion** | Marks text for removal | "Remove this section" |
39-
| **Replacement** | Suggests alternative text | "Change `WebSocket` to `SSE`" |
4039
| **Comment** | Adds feedback on a section | "This needs error handling" |
41-
| **Insertion** | Adds content after the selection | "Add a retry mechanism here" |
40+
| **Quick label** | Applies a preset label (⚡) | "Clarify this", "Needs tests", "Out of scope" |
41+
| **Looks good** | Marks a section as approved (👍) ||
4242
| **Global comment** | General feedback (not tied to text) | "The plan looks good overall but needs tests" |
4343

44+
If you want a replacement or an insertion, ask for it in a comment ("Change `WebSocket` to `SSE`" or "Add a retry mechanism here") — the agent will incorporate it during the revision.
45+
4446
## Image attachments
4547

4648
You can paste or upload images and attach them to annotations. Images are given human-readable names (e.g., "login-mockup") and referenced in the exported feedback. This is useful for sharing mockups, screenshots, or diagrams alongside your annotations.

apps/marketing/src/content/docs/getting-started/quickstart.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,15 @@ The plan renders as formatted markdown with syntax-highlighted code blocks. Read
3131
Select any text in the plan to open the annotation toolbar. Choose an action:
3232

3333
- **Delete** — Mark text for removal ("Remove this")
34-
- **Replace** — Suggest replacement text ("Change this to...")
3534
- **Comment** — Add feedback on a section ("This needs more detail")
36-
- **Insert** — Add new content after the selection ("Add error handling here")
35+
- **Quick label** (⚡) — Apply a preset label like "Clarify this", "Needs tests", or "Out of scope"
36+
- **Looks good** (👍) — Mark a section as approved
37+
- **Copy** — Copy the selected text to your clipboard
3738

3839
You can also add **global comments** — general feedback that isn't tied to specific text.
3940

41+
Need a replacement or an insertion? Just say so in a comment — the agent will handle it.
42+
4043
Switch between annotation modes using the mode switcher at the top of the document:
4144

4245
- **Select** — Click to select text, then choose an annotation type

apps/marketing/src/content/docs/getting-started/ui-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The mode switcher below the header in the plan review UI controls how text selec
116116

117117
| Mode | Behavior |
118118
|------|----------|
119-
| **Selection** (default) | Select text, then choose an annotation type from the toolbar (comment, deletion, replacement, insertion) |
119+
| **Selection** (default) | Select text, then choose an annotation type from the toolbar (comment, deletion, quick label, "looks good") |
120120
| **Comment** | Select text to immediately create a comment annotation |
121121
| **Redline** | Select text to immediately create a deletion annotation |
122122

apps/portal/ANNOTATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ The annotation tools are identical to plan review:
7474
Annotation types:
7575

7676
- **Deletion** — "Remove this"
77-
- **Replacement** — "Change this to..."
7877
- **Comment** — "Feedback on this..."
79-
- **Insertion** — "Add this after..."
8078
- **Global comment** — General feedback not tied to specific text
79+
- **Quick label** — Apply a preset label like "Clarify this" or "Needs tests"
80+
- **Looks good** — Mark a section as approved (👍)
8181

8282
Users can also paste or upload images and attach them to annotations.
8383

0 commit comments

Comments
 (0)