Skip to content

Document browser location controls - #602

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

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

Conversation

@tnsardesai

@tnsardesai tnsardesai commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

What

  • Adds browsers/location.mdx: setting, updating, clearing, and reading a browser session's timezone and locale.
  • Links the guide from the Configure page.

Why

  • Users need a precise contract for location overrides, region defaults, and updating one field without changing the other.

How

  • Per-field semantics: omit keeps the value, a string overrides it, and null/None clears it to the region default.
  • Validation and normalization (en-us → en-US, iw-IL → he-IL) and the invalid_browser_location error.
  • Response provenance (override / metro), runtime scope, CDP emulation precedence, and location vs. geolocation. Proxy-derived location is explicitly out of scope.
  • A pooled browser released with reuse: true keeps its location, like cookies and tabs; reuse: false gives a fresh browser.
  • TypeScript and Python examples for each operation.

Context

  • Documents kernel/kernel#4208. Merge after that API and its SDKs ship.
  • Proxy-derived location (kernel/kernel#4209) is excluded.
  • Docs only; no breaking changes.

Testing & Visuals

  • Mintlify deployment and broken-link checks pass; the preview is linked from the PR checks.
  • git diff --check is clean. mintlify dev was not run locally.
  • Open question: neither this page nor browsers/regions is in docs.json navigation. Is that intended?

Note

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

Overview
Adds a new Browser Location guide that documents how to set, patch, clear, and read a session’s timezone and locale on create and via browsers.update(), including per-field PATCH semantics (omit / string / null/None), validation and normalization, invalid_browser_location, response fields (timezone_source / locale_source), runtime scope, and what location does not cover (geolocation, proxy-derived defaults).

The Configure overview now links to that page under “More browser settings,” alongside Regions.

Reviewed by Cursor Bugbot for commit ad504ba. 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 15, 2026, 7:10 PM

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

@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 — ad504ba3 Deployed Oct 15, 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