Restructure How it works: Configure, Control, Scale, Observe, Manage - #671
andrewleesteele wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 4647ff9. Configure here.
| </Card> | ||
| <Card title="Authentication" icon="key" href="/auth/overview"> | ||
| Fill logins from a vault, or let managed auth handle the login and keep the session alive. | ||
| </Card> |
There was a problem hiding this comment.
Managed Auth over-claims session recovery
Medium Severity
New overview copy says managed auth will keep the session alive and will reauthenticate when a session expires. Automatic reauth is only an attempt on eligible flows, so this reads as a guarantee the rest of the auth docs already narrow.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit 4647ff9. Configure here.
| title: "Developing" | ||
| title: "Develop an App" | ||
| sidebarTitle: "Develop" | ||
| description: "Build an app with actions that run next to KERNEL browsers" |
There was a problem hiding this comment.
| description: "Build an app with actions that run next to KERNEL browsers" | |
| description: "Build an app with actions that run co-located with KERNEL browsers" |
|
|
||
| | Resource | Headful | Headless | | ||
| | --- | --- | --- | | ||
| | Default memory | 8 GB | 1 GB | |
There was a problem hiding this comment.
consider mentioning support for up to 16 GB in headful.
| </CodeGroup> | ||
|
|
||
| - **[Viewport](/browsers/viewport):** defaults to 1920x1080 at 25Hz. A custom viewport restarts Chromium on creation, so use a [browser pool](/browsers/pools) if you need it to be instant. | ||
| - **[Standby](/browsers/standby):** after 5 seconds with no CDP, WebDriver, live view, or computer controls activity, a browser goes into standby. It keeps its state and stops accruing usage cost until something reconnects. |
There was a problem hiding this comment.
i'd remove this here. not sure it belongs contextually.
|
|
||
| ## More browser settings | ||
|
|
||
| Most agents never need these, but they're there when you do: |
There was a problem hiding this comment.
| Most agents never need these, but they're there when you do: | |
| Often agents don't require these, but they're there when you do: |
| | [Playwright execution](/browsers/playwright-execution) | **Default.** You know what to do on the page — navigate, fill, extract, upload. | Needs a selector or DOM path that exists. | | ||
| | [Computer controls](/browsers/computer-controls) | **Recommended fallback.** A model is looking at pixels, or the page can't be driven programmatically. | Slower per step, and the model has to see the state to act. | | ||
| | [WebMCP](/browsers/webmcp) | The site exposes structured tools for the action you need. | Only works on sites that register tools. | | ||
| | [Browser REPL](/browsers/repl) | An agent writes its own helpers and reuses them across turns. | JavaScript only, and state lives until the REPL resets. | |
There was a problem hiding this comment.
I'd actually lean on Browser Repl as the default at this time for on-vm control
There was a problem hiding this comment.
"state lives until the REPL resets." i actually think this is a positive too of repl!
There was a problem hiding this comment.
On second thought, We can leave playwrighht execution as the default for now, but worth likely overhauling to default to browser repl once the dust settles on the docs
|
|
||
| | Surface | Use it when | Trade-off | | ||
| | --- | --- | --- | | ||
| | [Playwright execution](/browsers/playwright-execution) | **Default.** You know what to do on the page — navigate, fill, extract, upload. | Needs a selector or DOM path that exists. | |
There was a problem hiding this comment.
another trade-off here is that each playwright execution api call is stateless (vs. browser repl which is stateful across cells)
| **Costs:** a network round trip per action, disconnects to handle, screenshot and DOM bandwidth, and the CDP fingerprint above. It's fine for low-frequency or deterministic work, and it hurts most in a vision loop. | ||
| </Tab> | ||
| <Tab title="Playwright execution API"> | ||
| Send code, not commands. Each call runs in the browser's VM against the live session, so state carries across calls and an agent can drive the page turn by turn — one tool call per step, structured data back. |
There was a problem hiding this comment.
"so state carries across calls" this is true for browser repl but not playwright execution api
There was a problem hiding this comment.
i'd reco adding browser repl as a tab here too
|
|
||
| If you're building your own agent, [Browser Loop](/browsers/browser-loop) packages these surfaces as tools for each model provider and runs every action against a KERNEL browser, so you don't write the translation layer yourself. | ||
|
|
||
| ## Going deeper |
There was a problem hiding this comment.
i'd add browser repl in this list of additional reading options too
| @@ -0,0 +1,87 @@ | |||
| --- | |||
| title: "Browser Loop" | |||
There was a problem hiding this comment.
Consider removing from current PR and postpone inclusion till further internal discussion is done.


Summary
First layer of the guides IA restructure (stack: #671 → #672 → #673 → #674). Adds the How it works section — Configure, Control, Scale, Observe, Manage — each with an overview page, and reorganizes the pages under it so readers see the features that matter before the knobs.
Configure
Control
Scale
Observe — Browser telemetry pages grouped under their own section.
Manage — New overview with a multi-tenant setups section. Network Access is retitled as the firewall allowlist. Projects headings move to sentence case.
Across the section, overview pages get specific titles (for example "Proxies Overview") and headings use sentence case.
Stack notes
Merge the stack in order. Until #673 merges, pages not yet moved stay in their existing sidebar groups, so every layer builds and has no broken links on its own.
Open PRs to reconcile when merging
introduction/scale.mdxand reapply its pools/create edits with the new limits anchors.Testing
mint validateandmint broken-linkspass on this branch.🤖 Generated with Claude Code
Note
Low Risk
Documentation and navigation-only changes with redirects; no product or API behavior changes.
Overview
Restructures the Guides tab around a new How it works flow — Configure, Control, Scale, Observe, and Manage — each with an overview page and regrouped sidebar pages so readers hit the important concepts before deep dives.
Configure adds
introduction/configureand nests stealth, proxies, profiles, vaults, authentication (managed auth subgroup), payments, and config registry. Control rewritesintroduction/controlaround control-surface vs where-the-loop-runs choices, adds Browser Loop, and folds the code-execution platform into this section (develop/deploy/invoke/status/logs). Scale addsbrowsers/concurrency-and-limits(plan limits + rate limits) and retargets links that used to point at pricing anchors. Observe and Manage get overviews; manage covers projects, keys, audit logs, and the retitled firewall allowlist.Several standalone pages are merged and redirected in
docs.json: app secrets → deploy, stop invocation → invoke, managed auth credentials → connection configuration, hCaptcha → stealth. Cross-links and changelog entries follow the new anchors.Copy polish: task-oriented titles/descriptions (
sidebarTitle), sentence-case headings, vault credential-source table, expanded auth configuration content (formerly the credentials page), and wallet page title fixes.Reviewed by Cursor Bugbot for commit 4647ff9. Bugbot is set up for automated code reviews on this repo. Configure here.