Skip to content

docs: document chrome_policy on on-demand browsers#377

Open
aylee855 wants to merge 3 commits into
mainfrom
hypeship/docs-chrome-policy-on-demand
Open

docs: document chrome_policy on on-demand browsers#377
aylee855 wants to merge 3 commits into
mainfrom
hypeship/docs-chrome-policy-on-demand

Conversation

@aylee855
Copy link
Copy Markdown
Contributor

@aylee855 aylee855 commented May 22, 2026

Summary

  • Add a new /browsers/chrome-policy page that covers chrome_policy for both on-demand browsers.create() and reserved pools, with a quick reference of common policy keys.
  • Update /browsers/create-a-browser to show a chrome_policy (and start_url) example.
  • Slim down /browsers/pools/policy-json to focus on the pool-only update flow (discard_all_idle) and link out to the general reference for shared content.
  • Register browsers/chrome-policy in the Intermediate sidebar group in docs.json.

Test plan

  • Preview the new browsers/chrome-policy page and confirm code samples render correctly in both Typescript and Python tabs
  • Verify the sidebar shows the new page under "Working with your browser" → "Intermediate"
  • Click through internal links from create-a-browser, pools/policy-json, and chrome-policy to confirm they resolve

Note

Low Risk
Low risk: documentation-only changes that add a new guide and update links/examples without affecting runtime behavior.

Overview
Documents Chrome enterprise policies support via chrome_policy. Adds a new browsers/chrome-policy guide covering usage for both on-demand browsers.create() and reserved pools, including TypeScript/Python examples and a quick table of common policy keys.

Updates browsers/create-a-browser to show session launch customization with start_url + chrome_policy, and refactors browsers/pools/policy-json to focus on the pool-specific update flow (incl. discard_all_idle) while linking to the new shared reference. Registers the new page in the docs.json Intermediate sidebar navigation.

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

Add a new general /browsers/chrome-policy page covering chrome_policy for
both on-demand sessions and reserved pools. Update create-a-browser to
show the new options, and trim the pool-specific page to focus on
pool-only behavior (discard_all_idle) while linking to the general
reference.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@aylee855 aylee855 requested a review from ehfeng May 22, 2026 22:13
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 22, 2026

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

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview May 22, 2026, 10:18 PM

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

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
cursor[bot]
cursor Bot approved these changes May 22, 2026
@ehfeng ehfeng marked this pull request as ready for review May 22, 2026 22:25
@firetiger-agent
Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

Any PR that changes the kernel API. Monitor changes to API endpoints (packages/api/cmd/api/) and Temporal workflows (packages/api/lib/temporal) in the kernel repo

Reason: This PR only modifies documentation files and does not change any kernel API endpoints or Temporal workflows.

To monitor this PR anyway, reply with @firetiger monitor this.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Stale comment

Risk assessment: Very Low.

I assessed the actual diff: it adds browsers/chrome-policy.mdx, updates related browser docs, and adds one navigation entry in docs.json. This is documentation/sidebar content only, with no production codepaths, infrastructure, auth, billing, permissions, or shared runtime behavior changed. I also found no CODEOWNERS file indicating a Codeowners approval requirement.

The PR is already approved at the current head commit, so I’m not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

| `RestoreOnStartupURLs` | `string[]` | URLs to open when the browser starts. Requires `RestoreOnStartup` set to `4` |
| `BookmarkBarEnabled` | `boolean` | Shows the bookmark bar |
| `ManagedBookmarks` | `array` | Pre-configured bookmarks. Supports folders via nested `children` arrays |
| `DownloadBubbleEnabled` | `boolean` | Controls the download bubble UI. Set to `false` to fall back to the classic download shelf |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Deprecated Chrome policy documented with incorrect behavior

Medium Severity

DownloadBubbleEnabled is a deprecated Chrome policy (removed after Chrome 118). Its table description claims setting it to false falls back to "the classic download shelf," but this Chromium UI element no longer exists in modern Chrome. This references version-specific Chromium implementation details as product documentation and will mislead users since the policy has no effect. It's also used as a prominent example in code samples across both new pages, which compounds the issue.

Additional Locations (2)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit a5e62b0. Configure here.

Absolute URLs were rendering with extra inline spacing inside the
underlined link span. Relative paths render cleanly like other
api-reference links in the docs.
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Risk assessment: Very Low.

I assessed the current diff at the latest head: it adds browsers/chrome-policy.mdx, updates related browser documentation, trims duplicated pool-specific documentation, and adds one sidebar entry in docs.json. This is documentation/navigation content only, with no production codepaths, infrastructure, auth, billing, permissions, or shared runtime behavior changed.

I found no CODEOWNERS file in the repository. The PR is already approved, so I’m not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

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 and found 1 potential issue.

There are 2 total unresolved issues (including 1 from previous review).

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 1441b9a. Configure here.

`chrome_policy` is supported on:

- [`browsers.create()`](/api-reference/browsers/create-a-browser#body-chrome-policy) — on-demand browser sessions
- [`browserPools.create()`](/api-reference/browser-pools/create-a-browser-pool#body-chrome-policy) and [`browserPools.update()`](/api-reference/browser-pools/update-a-browser-pool#body-chrome-policy) — reserved browser pools
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Relative /api-reference/ links will break CI checks

High Severity

All /api-reference/... links in the new browsers/chrome-policy.mdx page (lines 10–11) and the updated browsers/pools/policy-json.mdx (line 6) use relative paths. API reference pages are auto-generated from a remote OpenAPI spec and don't exist locally, so relative links will fail the mint broken-links CI check. These need to be absolute URLs (e.g. https://kernel.sh/docs/api-reference/...). Notably, policy-json.mdx previously had the correct absolute URL and this PR regressed it to a relative one.

Additional Locations (1)
Fix in Cursor Fix in Web

Triggered by learned rule: Use absolute URLs for /api-reference/ links

Reviewed by Cursor Bugbot for commit 1441b9a. Configure here.

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