Skip to content

Refresh browser automation docs for current navigation flow - #1344

Closed
lawrencecchen wants to merge 5 commits into
mainfrom
issue-1335-browser-automation-docs
Closed

lawrencecchen wants to merge 5 commits into
mainfrom
issue-1335-browser-automation-docs

Conversation

@lawrencecchen

@lawrencecchen lawrencecchen commented Mar 13, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • align the browser automation docs with the current get-url-first navigation loop
  • document open vs navigate, blank-page recovery, and js_error fallbacks

Testing

  • jq empty web/messages/en.json web/messages/ja.json

Issues


Summary by cubic

Refreshes the browser automation docs to match the get‑url‑first navigation loop, clarify when to use open/open-split vs navigate, and add clear recovery steps for blank pages and js_error. Improves examples, adds Troubleshooting, and updates i18n across all locales (with German wording cleanups); closes #1335.

  • New Features
    • Inserts get url before wait/snapshot and updates the debug flow; clarifies open/open-split vs navigate.
    • Adds Troubleshooting with recovery for about:blank/empty snapshots and text/HTML fallbacks for js_error.

Written for commit c4c8ac9. Summary will update on new commits.

Summary by CodeRabbit

  • Documentation
    • Expanded browser automation docs with clearer navigation examples and a recommended navigate→verify→wait→snapshot pattern.
    • Added a troubleshooting section with guidance for blank pages and JavaScript errors during snapshots.
    • Added localization for browser automation content across multiple languages to improve international support.

@vercel

vercel Bot commented Mar 13, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cmux Ready Ready Preview, Comment Mar 25, 2026 5:04am

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 54cf37fef2

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread web/app/[locale]/docs/browser-automation/page.tsx

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

@coderabbitai

coderabbitai Bot commented Mar 13, 2026 •

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Added navigation guidance and a troubleshooting section to the Browser Automation docs page; also added corresponding localization keys across many language message files. (≤50 words)

Changes

Cohort / File(s) Summary
Docs - browser automation
web/app/[locale]/docs/browser-automation/page.tsx
Inserted descriptive text for navigation (navigationDesc, patternNavigateDesc), updated navigation examples to include explicit get url verification and surface creation vs reuse, and added a troubleshooting section with blank page and js_error scenarios and sample commands.
Localization - messages (multiple locales)
web/messages/en.json, web/messages/ja.json, web/messages/ar.json, web/messages/bs.json, web/messages/da.json, web/messages/de.json, web/messages/es.json, web/messages/fr.json, web/messages/it.json, web/messages/km.json, web/messages/ko.json, web/messages/no.json, web/messages/pl.json, web/messages/pt-BR.json, web/messages/ru.json, web/messages/th.json, web/messages/tr.json, web/messages/zh-CN.json, web/messages/zh-TW.json
Added new keys under the browserAutomation block: navigationDesc, patternNavigateDesc, troubleshooting, troubleBlankPage, troubleBlankPageDesc, troubleJsError, troubleJsErrorDesc (JSON string additions only).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Poem

🐰 I hopped through docs with nimble feet,
Added checks so navigation's neat.
When pages blank or scripts misbehave,
I leave a trail to help you save.
Snapshots steady — hop, skip, repeat.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title accurately describes the main change: refreshing browser automation documentation to align with the current navigation flow, which is the primary focus of this changeset.
Linked Issues check ✅ Passed The pull request comprehensively addresses all objectives from issue #1335: documents open vs navigate differences, adds get url verification guidance, introduces troubleshooting for blank pages and js_error, updates examples, and adds i18n strings across all locales.
Out of Scope Changes check ✅ Passed All changes are directly related to refreshing browser automation documentation and translations. The modifications focus on the page content, descriptions, and i18n strings without introducing unrelated functionality or logic changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description covers all required template sections with clear, actionable content.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch issue-1335-browser-automation-docs

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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
web/app/[locale]/docs/browser-automation/page.tsx (1)

280-282: Re-verify URL after recovery navigation.

In the recovery flow, add a second URL check after Line 280 so the snippet fully follows the “verify before wait/snapshot” pattern.

Suggested snippet tweak
 cmux browser surface:2 navigate https://example.com
+cmux browser surface:2 get url
 cmux browser surface:2 wait --load-state complete --timeout-ms 15000
 cmux browser surface:2 snapshot --interactive --compact
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@web/app/`[locale]/docs/browser-automation/page.tsx around lines 280 - 282,
After the recovery navigation step, add a second URL verification so the snippet
follows the “verify before wait/snapshot” pattern: after the existing "cmux
browser surface:2 navigate https://example.com" recovery call, insert another
URL check (i.e., re-verify the target URL) before calling "cmux browser
surface:2 wait --load-state complete --timeout-ms 15000" and "cmux browser
surface:2 snapshot --interactive --compact" to ensure the page is confirmed
loaded on the expected URL prior to waiting and snapshotting.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@web/messages/en.json`:
- Line 519: The documentation string under the JSON key "navigationDesc" uses
both "navigate" and "goto" inconsistently; update that value so command naming
matches the canonical command set (either replace "goto" with "navigate" or
explicitly mention "`goto` (alias of `navigate`)") so the text consistently
references the documented command name used elsewhere (navigationDesc).

In `@web/messages/ja.json`:
- Line 518: The sentence in navigationDesc currently mentions both
"navigateまたはgoto", causing inconsistency with the rest of the docs where the
primary command name is "navigate"; update navigationDesc to use the same
canonical command name ("navigate") everywhere (or alternatively add "goto" to
the main command list if you intend to keep both), ensuring references to open,
open-split, wait, snapshot remain unchanged and the phrasing matches the command
list and samples.

---

Nitpick comments:
In `@web/app/`[locale]/docs/browser-automation/page.tsx:
- Around line 280-282: After the recovery navigation step, add a second URL
verification so the snippet follows the “verify before wait/snapshot” pattern:
after the existing "cmux browser surface:2 navigate https://example.com"
recovery call, insert another URL check (i.e., re-verify the target URL) before
calling "cmux browser surface:2 wait --load-state complete --timeout-ms 15000"
and "cmux browser surface:2 snapshot --interactive --compact" to ensure the page
is confirmed loaded on the expected URL prior to waiting and snapshotting.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fbb72aaf-2101-41ab-b143-5e28a829aa96

📥 Commits

Reviewing files that changed from the base of the PR and between 2596f78 and 54cf37f.

📒 Files selected for processing (3)
  • web/app/[locale]/docs/browser-automation/page.tsx
  • web/messages/en.json
  • web/messages/ja.json

Comment thread web/messages/en.json Outdated
Comment thread web/messages/ja.json Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
web/messages/ko.json (1)

539-539: Use one consistent term for surface in Korean copy.

Line 539 switches to “표면” while the rest of this section uses “서피스”, which may read as two different concepts.

✏️ Suggested wording tweak
-      "navigationDesc": "open 또는 open-split을 사용해 새 브라우저 표면을 만들고 URL을 로드하세요. 이미 표면이 있고 페이지를 바꾸고 싶다면 navigate 또는 goto를 사용하세요. 어느 쪽이든 기다리거나 스냅샷을 찍기 전에 먼저 URL을 확인하세요.",
+      "navigationDesc": "open 또는 open-split을 사용해 새 브라우저 서피스를 만들고 URL을 로드하세요. 이미 서피스가 있고 페이지를 바꾸고 싶다면 navigate 또는 goto를 사용하세요. 어느 쪽이든 기다리거나 스냅샷을 찍기 전에 먼저 URL을 확인하세요.",
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@web/messages/ko.json` at line 539, The translation for key "navigationDesc"
uses "표면" while the rest of the section uses "서피스"; update the string value for
navigationDesc to replace "표면" with "서피스" so terminology is consistent across
the file (modify the value associated with the navigationDesc key).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@web/messages/de.json`:
- Around line 539-543: The German locale uses informal "du" in the provided
strings (navigationDesc, patternNavigateDesc, troubleBlankPageDesc) which
conflicts with the project's formal "Sie" register; update these keys to formal
phrasing (e.g., change "Verwende" → "Verwenden Sie", "du" → "Sie", "prüfe" →
"prüfen Sie", "du möchtest" → "Sie möchten", etc.) and ensure verbs and sentence
structure match formal tone consistently across navigationDesc,
patternNavigateDesc, troubleBlankPageDesc (and any nearby strings that refer to
the same actions).

---

Nitpick comments:
In `@web/messages/ko.json`:
- Line 539: The translation for key "navigationDesc" uses "표면" while the rest of
the section uses "서피스"; update the string value for navigationDesc to replace
"표면" with "서피스" so terminology is consistent across the file (modify the value
associated with the navigationDesc key).

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: da8c0728-17bb-4379-9adc-d0a8626525f8

📥 Commits

Reviewing files that changed from the base of the PR and between 54cf37f and 6685e15.

📒 Files selected for processing (17)
  • web/messages/ar.json
  • web/messages/bs.json
  • web/messages/da.json
  • web/messages/de.json
  • web/messages/es.json
  • web/messages/fr.json
  • web/messages/it.json
  • web/messages/km.json
  • web/messages/ko.json
  • web/messages/no.json
  • web/messages/pl.json
  • web/messages/pt-BR.json
  • web/messages/ru.json
  • web/messages/th.json
  • web/messages/tr.json
  • web/messages/zh-CN.json
  • web/messages/zh-TW.json

Comment thread web/messages/de.json Outdated

This branch was successfully deployed

1 active deployment
Preview — c4c8ac9f Deployed Mar 25, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

stale-revisit Closed after 30+ days without activity; preserved for possible revisit or reopening.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Browser automation docs still teach stale navigation and troubleshooting patterns

2 participants