Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/marketing/src/content/blog/plannotator-meets-pi.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Because the plan lives on disk as a regular file, you can open it in your editor

### Review phase

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.
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.

Three outcomes:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ You paste this in Slack and send it to your senior teammate.
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:

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

Each annotation is tied to the specific text it references.

Expand All @@ -49,7 +49,7 @@ Your senior clicks **Export β†’ Copy Link** to share their annotated version bac

### 5. You send combined feedback to Claude

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.
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.

## How the hook integration works

Expand Down
2 changes: 1 addition & 1 deletion apps/marketing/src/content/blog/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Plannotator is a plan review UI for Claude Code that intercepts `ExitPlanMode` v

## What is Plannotator?

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.
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.

## Key Features

Expand Down
2 changes: 1 addition & 1 deletion apps/marketing/src/content/docs/commands/annotate.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The annotation UI in annotate mode works the same as plan review, with a few cha
- `Cmd/Ctrl+Enter` sends annotations instead of approving
- The completion screen says "Annotations Sent" instead of "Plan Approved"

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

## Flags

Expand Down
2 changes: 1 addition & 1 deletion apps/marketing/src/content/docs/commands/code-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The review UI shows your changes in a familiar diff format:
- **File tree sidebar** for navigating between changed files
- **Viewed tracking** to mark files as reviewed and track your progress
- **Unified diff** showing additions and deletions in context
- **Annotation tools** with the same annotation types as plan review (delete, replace, comment, insert)
- **Annotation tools** with the same annotation types as plan review (delete, comment, quick label, "looks good")

## Annotating code

Expand Down
6 changes: 4 additions & 2 deletions apps/marketing/src/content/docs/commands/plan-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,13 @@ When you select text in the plan, the annotation toolbar appears with these opti
| Type | What it does | Example |
|------|-------------|---------|
| **Deletion** | Marks text for removal | "Remove this section" |
| **Replacement** | Suggests alternative text | "Change `WebSocket` to `SSE`" |
| **Comment** | Adds feedback on a section | "This needs error handling" |
| **Insertion** | Adds content after the selection | "Add a retry mechanism here" |
| **Quick label** | Applies a preset label (⚑) | "Clarify this", "Needs tests", "Out of scope" |
| **Looks good** | Marks a section as approved (πŸ‘) | β€” |
| **Global comment** | General feedback (not tied to text) | "The plan looks good overall but needs tests" |

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.

## Image attachments

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.
Expand Down
7 changes: 5 additions & 2 deletions apps/marketing/src/content/docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,15 @@ The plan renders as formatted markdown with syntax-highlighted code blocks. Read
Select any text in the plan to open the annotation toolbar. Choose an action:

- **Delete** β€” Mark text for removal ("Remove this")
- **Replace** β€” Suggest replacement text ("Change this to...")
- **Comment** β€” Add feedback on a section ("This needs more detail")
- **Insert** β€” Add new content after the selection ("Add error handling here")
- **Quick label** (⚑) β€” Apply a preset label like "Clarify this", "Needs tests", or "Out of scope"
- **Looks good** (πŸ‘) β€” Mark a section as approved
- **Copy** β€” Copy the selected text to your clipboard

You can also add **global comments** β€” general feedback that isn't tied to specific text.

Need a replacement or an insertion? Just say so in a comment β€” the agent will handle it.

Switch between annotation modes using the mode switcher at the top of the document:

- **Select** β€” Click to select text, then choose an annotation type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ The mode switcher below the header in the plan review UI controls how text selec

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

Expand Down
4 changes: 2 additions & 2 deletions apps/portal/ANNOTATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ The annotation tools are identical to plan review:
Annotation types:

- **Deletion** β€” "Remove this"
- **Replacement** β€” "Change this to..."
- **Comment** β€” "Feedback on this..."
- **Insertion** β€” "Add this after..."
- **Global comment** β€” General feedback not tied to specific text
- **Quick label** β€” Apply a preset label like "Clarify this" or "Needs tests"
- **Looks good** β€” Mark a section as approved (πŸ‘)

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

Expand Down