Skip to content

Apply brand tone and writing style fixes #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Apply brand tone and writing style fixes #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 ai/agents/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebarTitle: "Overview"
description: "Build review agents for your product that review web pages, data, charts, and anything else you can surface via API or MCP, then create findings as comment annotations."
---

## What are Review Agents?
## What are review agents?

Build review agents for your product. Point an agent at a URL, and it reviews the content and posts findings as comment annotations.

Expand Down
4 changes: 2 additions & 2 deletions async-collaboration/suggestions/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The accept/reject UI renders on the Velt comment dialog, so your app needs Velt
- Suggestion mode is global for the current user and **not persisted**. A page reload returns to normal editing until you enable it again.
- An edit is committed when the user finishes it, not on every keystroke. Text-like inputs (text, number, date, textarea, contenteditable) commit when the field loses focus (`focusout`), so each focus session produces at most one suggestion. Dropdowns, checkboxes, and radios commit on `change`, since picking a value is the whole edit.
- Unchanged values never create suggestions. Focusing and blurring without editing is ignored, and `commitSuggestion` rejects a `newValue` that's identical to the old value.
- Events come from two elements: accept/reject outcomes are emitted on the **comment element**, while the rest of the lifecycle (`suggestionCreated`, `suggestionStale`, `targetEditStart`, `targetEditCommit`) is emitted on the **SuggestionElement**. See [Event Subscription](#event-subscription).
- Events come from two elements: accept/reject outcomes are emitted on the **comment element**, while the rest of the lifecycle (`suggestionCreated`, `suggestionStale`, `targetEditStart`, `targetEditCommit`) is emitted on the **SuggestionElement**. See [Event subscription](#event-subscription).
- **The SDK never mutates your data.** It captures intent, orchestrates review, and persists the outcome. Applying the change is your code's job.
- Drift detection is best-effort. On accept, if a getter is registered, the live value is compared against `oldValue`; a mismatch sets `driftDetected: true` on the suggestion. v1 records the flag; a future release will surface a confirmation prompt.
- Stale wins over drift. If the target DOM node can't be resolved at accept time, the suggestion transitions to `stale` immediately and drift detection is skipped.
Expand Down Expand Up @@ -424,7 +424,7 @@ Suggestions are stored as comment annotations, so you manage them from your back
- Update annotation-level fields using the Update Comment Annotations REST API. [Learn more](/api-reference/rest-apis/v2/comments-feature/comment-annotations/update-comment-annotations)
- Delete suggestion threads using the Delete Comment Annotations REST API. [Learn more](/api-reference/rest-apis/v2/comments-feature/comment-annotations/delete-comment-annotations)

## Event Subscription
## Event subscription

### [on](/api-reference/sdk/api/api-methods#on-6)

Expand Down