Refresh browser pool guides and standardize on "browser pools" - #464
Draft
andrewleesteele wants to merge 1 commit into
Draft
Refresh browser pool guides and standardize on "browser pools"#464andrewleesteele wants to merge 1 commit into
andrewleesteele wants to merge 1 commit into
Conversation
Add a Browser Pools Quickstart, move the pool guides from Advanced to Basics, and use "browser pools" as the single name for the concept everywhere in the docs (the API, SDKs, CLI, and dashboard already do). Push pools as the production path from the Create page, the home page, and the Scale guide, and lead with the fact that idle pooled browsers aren't billed.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Author
|
Note: Hypeship prematurely created this PR...still thinking necessary changes through. |
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
Browser pools are the thing most production workloads want on day one, but the docs don't lead anyone there: the concept is called "Reserved Browsers" in the sidebar, it's filed under Advanced, there's no quickstart, and the Create page never mentions it.
This PR does four things:
1. One name: "browser pools." The API (
/browser_pools), SDKs (browserPools/browser_pools), CLI (kernel browser-pools), and dashboard all already use it, so the docs were the outlier. Renamed the sidebar groupReserved Browsers→Browser Poolsand dropped "reserved browsers" as a product name across the docs. Where "reserved" was doing real work (concurrency accounting), it's reworded to say the thing directly — "a pool sized to 40 browsers uses 40 of your limit." Historical changelog entries are left alone.2. Moved the pool guides from Advanced to Basics, next to the concurrency-limits page they interact with. No URLs changed, so no redirects are needed.
3. New Browser Pools Quickstart — create a pool, acquire/drive/release a browser, watch
available_countto size it, plus a "before you go to production" section covering the three behaviors that differ from on-demand browsers (timeout only runs while acquired,updatedoesn't reconfigure existing browsers, pool profiles are read-only). TypeScript, Python, Go, and CLI examples throughout. It's now the first page in the group; Overview is positioned as the full API surface.4. Pools are pitched from the pages new users actually land on. Added an "On demand or from a pool" section to
introduction/createwith the create-once/acquire-per-task pattern, a pointer from the home page's scaling section, and a pointer fromintroduction/scaleto the quickstart for mechanics. Every one of these leads with the fact that idle pooled browsers aren't billed — the most common misconception, and the one that most often flips someone from "pools sound expensive" to "why wouldn't I use these."Also added a
Browser Poolentry to the Concepts page.Verification
docs.jsonis valid JSON and every page path in the navigation resolves to a file.#create-a-poolanchor (was#create-a-pool-of-reserved-browsers, referenced from two places).sizeis required onupdate.mint devin my environment, so the pages aren't visually confirmed. Worth a look at the preview before merge.Open questions
/browsers/pools, which has no page (they need/browsers/pools/overview).🤖 Generated with Claude Code