Add a Get started section with an end-to-end quickstart - #470
Draft
andrewleesteele wants to merge 4 commits into
Draft
Add a Get started section with an end-to-end quickstart#470andrewleesteele wants to merge 4 commits into
andrewleesteele wants to merge 4 commits into
Conversation
The docs had no code-along path: the home page is a landing page, and each guide covers one stage in isolation. Add a Quickstart that runs install → create and drive a browser → observe it → serve a workload from a browser pool, and put it in a new "Get started" nav group with room for more onboarding pages. Browser pools are the last stage rather than a separate quickstart, so the walkthrough (create the pool once, acquire/drive/release per task, plus the three production gotchas) lives here and the pools page keeps only reference material — its Full example moves into this guide. Drops the stale /quickstart -> / redirect from when the old quickstart was folded into the home page. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The sidebar should lead with Introduction, not the quickstart. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The pools reference page now states the behavior and constraint; the step-by-step and its code belong here, alongside the rest of the browser-pool walkthrough. Points at Managed Auth for keeping those profiles logged in. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Risk assessment: Very Low
Verdict: Very Low risk — approved.
Evidence (from diff only)
| File | Change |
|---|---|
quickstart.mdx |
New Mintlify docs page (end-to-end install → browser → pools walkthrough with TS/Python examples) |
docs.json |
Adds Get started nav group; removes /quickstart → / redirect so the new page is reachable |
index.mdx |
Adds a link to /quickstart |
browsers/pools.mdx |
Adds an Info callout pointing readers to the quickstart |
Why Very Low
- Documentation-only on a Mintlify docs site — no application code, APIs, auth, billing, infra, or runtime logic.
- Small, scoped surface: one new guide page plus navigation/cross-link wiring.
- No shared libraries, schemas, deployments, or security boundaries touched.
- No CODEOWNERS file requiring human ownership review.
Action
Approved per Very Low risk criteria. No reviewers assigned.
Sent by Cursor Automation: Assign PR reviewers
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
The docs have no code-along path. The home page is a landing page, and each guide covers one stage in isolation — so there's nowhere to send someone who just wants to get a browser running and then take it to production.
This adds a Quickstart in a new
Get startednav group: install and authenticate → create and drive a browser → watch it → pointers for stealth/proxies/auth → serve a workload from a browser pool.Browser pools are the last stage of this guide rather than a quickstart of their own, so the walkthrough lives here and
/browsers/poolsstays reference-only. Its "Full example" moves into this guide, and the pools page gets a short pointer back.Also drops the stale
/quickstart→/redirect, left over from when an earlier quickstart was folded into the home page — without removing it, the new page would be shadowed. The home page's "start here" now links into the guide.Content notes
finally(an unreleased browser staysacquireduntil timeout and the pool drains),reuse: truehands the same browser — cookies and logins included — to the next caller, and idle pooled browsers aren't billed but their capacity still counts against the concurrency limit.brew install kernel/tap/kernel/npm install -g @onkernel/cli,kernel login,kernel api-keys create, andKERNEL_API_KEYfor the SDKs.Get startedsits belowOverview, so the sidebar still leads with Introduction.Base branch
This is stacked on
hypeship/browser-pools-docs-refresh(#464) rather thanmain, because the pools-page edits here depend on that branch renamingbrowsers/pools/overview.mdx→browsers/pools.mdx. Merge #464 first, then this. Its diff shows only the quickstart changes.Verification
docs.jsonis valid JSON; every nav entry resolves to a file;quickstartis in the nav; no stale/quickstartredirect remains.quickstart.mdx; all internal links andCardhrefs resolve, including/browsers/pools#sizing-a-browser-pool.mint devnot booted in this environment, so the page isn't visually confirmed — worth a preview pass.Needs a human call
#278 ("Redesign quickstart with agent-first one-command approach") also creates
quickstart.mdx. I left it untouched. Close it, or fold its one-command approach into this guide before merge — the home page already carries a copy-prompt setup box that covers similar ground.🤖 Generated with Claude Code