Skip to content

Fix inverted discard_all_idle default in pool docs#433

Merged
masnwilliams merged 1 commit into
mainfrom
hypeship/fix-pool-update-default
Jul 2, 2026
Merged

Fix inverted discard_all_idle default in pool docs#433
masnwilliams merged 1 commit into
mainfrom
hypeship/fix-pool-update-default

Conversation

@masnwilliams

@masnwilliams masnwilliams commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Corrects the discard_all_idle default across the browser-pools docs. The API default is false — a plain update() leaves existing idle browsers on their original config and only newly created browsers pick up the change. The docs stated the inverse (discards-idle-by-default), which was merged in #431 and also predated it.

Source of truth confirming default = false:

  • Handler packages/api/cmd/api/api/browser_pools.go only flushes if DiscardAllIdle != nil && *DiscardAllIdle — omitted means no rebuild.
  • Generated oapi.go: DiscardAllIdle *bool (omitempty).
  • Dashboard edit-pool-dialog.tsx: checkbox defaults to false.
  • OpenAPI spec: discard_all_idle has default: false (kernel/kernel#2591 keeps this correct).

Changes

  • browsers/pools/overview.mdx — "Update a pool" intro, the discard_all_idle paragraph, and the <Warning> parenthetical: flip to keep-idle-by-default; pass discard_all_idle: true (or flush()) to rebuild idle browsers.
  • browsers/pools/faq.mdx — "Can I update a pool's configuration…", "…do browsers currently in use pick up the new configuration?", and "Can I use different browser configurations…": same correction, and clarify that a plain update() rebuilds nothing already-warm.

Open question

This assumes keep-idle-by-default is intended (code, spec, and dashboard all agree). If the product intent was discard-by-default, this is instead a code/spec bug and the fix belongs there — flagging for a quick confirm before merge.

Test plan

  • Mintlify preview renders both pages; <Warning> and the flush() anchor resolve.

Note

Low Risk
Documentation-only changes with no runtime or API behavior impact.

Overview
Fixes browser pool documentation that incorrectly described discard_all_idle as discarding idle browsers by default on update().

browsers/pools/overview.mdx and browsers/pools/faq.mdx now state the API default is discard_all_idle: false: a plain kernel.browserPools.update() leaves existing idle browsers on their original config and only applies the new configuration to browsers created afterward. discard_all_idle: true or flush() is documented as the way to rebuild idle browsers immediately.

Related FAQ and warning copy is updated so it no longer claims idle browsers are rebuilt by default, and it clarifies that in-use browsers are never rebuilt during an update regardless of the flag.

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

The default is discard_all_idle: false — a plain update() leaves existing
idle browsers on their original config and only new browsers pick up the
change. The docs stated the opposite (discard-by-default). Corrects the
overview and FAQ to match the API default.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@masnwilliams masnwilliams marked this pull request as ready for review July 2, 2026 16:22
@masnwilliams masnwilliams requested a review from AnnaXWang July 2, 2026 16:22

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

Risk assessment: Very Low

This PR changes only two MDX documentation pages under browsers/pools/, with a small 6-addition/6-deletion diff clarifying the documented default behavior for discard_all_idle. I found no code, configuration, navigation, prompt, infrastructure, auth, billing, permissions, or schema changes, and no CODEOWNERS file in the workspace requiring owner review.

Approved because the blast radius is limited to docs content and the risk is Very Low.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Jul 2, 2026, 4:28 PM

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

@masnwilliams masnwilliams merged commit 01fa777 into main Jul 2, 2026
4 checks passed
@masnwilliams masnwilliams deleted the hypeship/fix-pool-update-default branch July 2, 2026 20:26
@eclairen eclairen mentioned this pull request Jul 2, 2026
2 tasks
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