Fix inverted discard_all_idle default in pool docs#433
Merged
Conversation
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>
There was a problem hiding this comment.
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.
Sent by Cursor Automation: Assign PR reviewers
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
AnnaXWang
approved these changes
Jul 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Summary
Corrects the
discard_all_idledefault across the browser-pools docs. The API default isfalse— a plainupdate()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:packages/api/cmd/api/api/browser_pools.goonly flushesif DiscardAllIdle != nil && *DiscardAllIdle— omitted means no rebuild.oapi.go:DiscardAllIdle *bool(omitempty).edit-pool-dialog.tsx: checkbox defaults tofalse.discard_all_idlehasdefault: false(kernel/kernel#2591 keeps this correct).Changes
browsers/pools/overview.mdx— "Update a pool" intro, thediscard_all_idleparagraph, and the<Warning>parenthetical: flip to keep-idle-by-default; passdiscard_all_idle: true(orflush()) 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 plainupdate()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
<Warning>and theflush()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_idleas discarding idle browsers by default onupdate().browsers/pools/overview.mdxandbrowsers/pools/faq.mdxnow state the API default isdiscard_all_idle: false: a plainkernel.browserPools.update()leaves existing idle browsers on their original config and only applies the new configuration to browsers created afterward.discard_all_idle: trueorflush()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.