Skip to content

docs(cua-driver): clarify delivery_mode fallback - #2095

Merged
f-trycua merged 1 commit into
trycua:mainfrom
injaneity:docs/delivery-mode-tolerance
Jul 1, 2026
Merged

docs(cua-driver): clarify delivery_mode fallback#2095
f-trycua merged 1 commit into
trycua:mainfrom
injaneity:docs/delivery-mode-tolerance

Conversation

@injaneity

@injaneity injaneity commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Clarifies the 0.7.0 delivery_mode contract: the advertised values are background and foreground, while omitted, unknown, or legacy values such as auto resolve to background for safety/back-compat instead of silently fronting the target. No code behavior changes.

Summary by CodeRabbit

  • Documentation
    • Clarified how input delivery works for actions, including the allowed delivery_mode values.
    • Noted that background is the default, while foreground remains available where supported.
    • Explained that omitted, unknown, or legacy values now fall back to background.
    • Reinforced that certain actions always run in the background and do not need this setting.

@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

@injaneity is attempting to deploy a commit to the Cua Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e8456378-f34a-4cee-8a32-0cad69adc22a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Documentation updates clarify that the delivery_mode parameter now supports only background and foreground values, with the legacy auto heuristic removed. Omitted, unknown, or stray legacy values default to background instead of fronting the target.

Changes

Delivery Mode Documentation

Layer / File(s) Summary
Dispatch modality explanation
docs/content/docs/explanation/capture-and-dispatch-modalities.mdx
Clarifies removal of the auto heuristic, defines new fallback behavior where omitted/unknown/legacy values resolve to background, and restates element ax and pixel-rung dispatch behavior.
MCP tool parameter reference
docs/content/docs/reference/cua-driver/mcp-tool-notes.mdx
Revises the delivery_mode row in the "Common parameters" table to state allowed values are background (default) and foreground, with legacy/unknown values resolving to background.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • trycua/cua#2053: Introduced the "Capture and Dispatch Modalities" page and dispatch-axis rules that this PR's docs directly build upon.
  • trycua/cua#2077: Implements the schema/behavior change restricting delivery_mode to background/foreground with legacy fallback, matching these doc clarifications.

Poem

A hop, a nibble, a docs-page cleared,
"auto" the carrot has disappeared! 🥕
Now background waits, safe and sound,
for values stray or unknown-bound.
Foreground still shines when called by name—
this bunny scribes the rules again. 🐇📖

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the docs-only change clarifying the delivery_mode fallback behavior.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@injaneity
injaneity force-pushed the docs/delivery-mode-tolerance branch from a6d9a28 to 955ca31 Compare July 1, 2026 15:37
@f-trycua
f-trycua merged commit 422cde0 into trycua:main Jul 1, 2026
5 of 7 checks passed
@injaneity
injaneity deleted the docs/delivery-mode-tolerance branch July 3, 2026 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants