Skip to content

Document browser location controls - #602

Open
tnsardesai wants to merge 4 commits into
mainfrom
hypeship/browser-location-docs
Open

tnsardesai wants to merge 4 commits into
mainfrom
hypeship/browser-location-docs

Conversation

@tnsardesai

@tnsardesai tnsardesai commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

summary

Documents explicit browser location:

  • set timezone and locale on create or with browsers.update(); omitted fields use the default for the browser's region
  • PATCH is per field: omit leaves it unchanged, a string overrides, null/None clears back to the region default
  • validation and normalization (en-us → en-US, iw-IL → he-IL; 400 invalid_browser_location for values such as en-QQ)
  • response provenance is override or metro; pending while the running browser applies a change
  • runtime behavior, CDP emulation layering, and overrides cleared at pool release
  • states that location is not derived from the proxy; links it from Configure

Proxy-based selection is not documented; it ships later with kernel #4209.

dependencies

  • kernel #4208 at 55dbacde6ff00a123e73c2245d25a2e304a04002 (API) and its SDK release. Merge after the API has deployed.

validation

  • python3 -m json.tool docs.json, git diff --check, internal links resolve

Note

Low Risk
Documentation-only changes with no runtime or API behavior in this repo.

Overview
Adds a Browser Location guide (browsers/location.mdx) documenting session timezone and locale: defaults from the browser region, optional overrides on browsers.create() and live updates via browsers.update() without restarting Chromium.

The page covers PATCH semantics (omit / string / null/None), validation and normalization, response fields (timezone_source, locale_source, pending), runtime effects, limits (not geolocation or proxy-derived), and that overrides don’t persist through pools or profiles.

Configure (introduction/configure.mdx) now links Location under “More browser settings” next to Regions.

Reviewed by Cursor Bugbot for commit 47bb685. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Kernel 🟢 Ready View Preview Oct 9, 2026, 11:06 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Location is set explicitly per session; omitted or cleared fields use the default for the browser's region. Proxy-based selection is not documented until it ships.
@tnsardesai
tnsardesai marked this pull request as ready for review October 9, 2026 22:54

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 032fb40. Configure here.

Comment thread browsers/location.mdx Outdated

This branch was successfully deployed

1 active deployment
staging — 47bb6857 Deployed Oct 9, 2026 by mintlify[bot]
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.

1 participant