Skip to content

Add a Get started section with an end-to-end quickstart - #470

Draft
andrewleesteele wants to merge 10 commits into
hypeship/browser-pools-docs-refreshfrom
hypeship/docs-quickstart
Draft

Add a Get started section with an end-to-end quickstart#470
andrewleesteele wants to merge 10 commits into
hypeship/browser-pools-docs-refreshfrom
hypeship/docs-quickstart

Conversation

@andrewleesteele

Copy link
Copy Markdown
Contributor

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 started nav 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/pools stays 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

  • The browser-pool stage ends with the three things that actually bite in production: always release in a finally (an unreleased browser stays acquired until timeout and the pool drains), reuse: true hands 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.
  • CLI and SDK details are taken from the existing CLI reference rather than invented: brew install kernel/tap/kernel / npm install -g @onkernel/cli, kernel login, kernel api-keys create, and KERNEL_API_KEY for the SDKs.
  • Nav: Get started sits below Overview, so the sidebar still leads with Introduction.

Base branch

This is stacked on hypeship/browser-pools-docs-refresh (#464) rather than main, because the pools-page edits here depend on that branch renaming browsers/pools/overview.mdxbrowsers/pools.mdx. Merge #464 first, then this. Its diff shows only the quickstart changes.

Verification

  • docs.json is valid JSON; every nav entry resolves to a file; quickstart is in the nav; no stale /quickstart redirect remains.
  • Code fences and MDX tags balance in quickstart.mdx; all internal links and Card hrefs resolve, including /browsers/pools#sizing-a-browser-pool.
  • Pools page still balances its fences/tags after the Full example was removed, and no references to it remain.
  • mint dev not 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

andrewleesteele and others added 2 commits July 30, 2026 03:29
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>
@vercel

vercel Bot commented Jul 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Error Error Jul 30, 2026 8:22pm

andrewleesteele and others added 2 commits July 30, 2026 17:08
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>
cursor[bot]
cursor Bot approved these changes Jul 30, 2026
andrewleesteele and others added 2 commits July 30, 2026 17:45
It described the page as the full API surface, which stopped being true
once the CRUD sections collapsed into the operations table.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

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

Stale comment

Risk assessment: Very Low

Verdict: Very Low risk — prior approval retained (risk did not increase after synchronize).

Evidence (from diff only)

File Change
quickstart.mdx New Mintlify docs page (install → drive browser → pools walkthrough with TS/Python/Go 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

Re-evaluation after update

Previously approved at 77c3e06. New HEAD 63eda69 (plus merge from base) only adjusts the pools Info callout wording after the base branch trimmed that page. Still documentation-only; blast radius unchanged.

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

Comment only — already approved and risk did not increase, so approval is not dismissed and is not re-issued. No reviewers assigned.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

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

Stale comment

Risk assessment: Very Low

Verdict: Very Low risk — prior approval retained (risk did not increase after synchronize).

Evidence (from diff only)

File Change
quickstart.mdx New Mintlify docs page (install → drive browser → pools walkthrough with TS/Python/Go 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

Re-evaluation after update

Previously approved at 77c3e06. New HEAD 51eb068 merges latest base (hypeship/browser-pools-docs-refresh). Relative to the last assessment commit (63eda69), the only file touched is browsers/pools.mdx via that merge (section reorder/trim on the base branch). This PR’s own delta remains the Info callout plus the quickstart/nav/home wiring above. Still documentation-only; blast radius unchanged.

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

Comment only — already approved and risk did not increase, so approval is not dismissed and is not re-issued. No reviewers assigned.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

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

Stale comment

Risk assessment: Very Low

Verdict: Very Low risk — prior approval retained (risk did not increase after synchronize).

Evidence (from diff only)

File Change
quickstart.mdx New Mintlify docs page (install → drive browser → pools walkthrough with TS/Python/Go 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

Re-evaluation after update

Previously approved at 77c3e06. New HEAD 329a6b3 merges latest base (hypeship/browser-pools-docs-refresh). Relative to the last assessment commit (51eb068), the merge brings base-branch edits into browsers/pools.mdx / info/pricing.mdx; this PR’s three-dot delta vs base remains documentation-only (quickstart page, nav/redirect wiring, home link, pools Info callout). Blast radius unchanged.

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

Comment only — already approved and risk did not increase, so approval is not dismissed and is not re-issued. No reviewers assigned.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

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

Stale comment

Risk assessment: Very Low

Verdict: Very Low risk — prior approval retained (risk did not increase after synchronize).

Evidence (from diff only)

File Change
quickstart.mdx New Mintlify docs page (install → drive browser → pools walkthrough with TS/Python/Go 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

Re-evaluation after update

Previously approved at 77c3e06. New HEAD 2b7711c merges latest base (hypeship/browser-pools-docs-refresh). Relative to the last assessed tip, incoming base merges touch other docs pages (browsers/pools.mdx polish, plus unrelated base-branch edits pulled in by the merge). This PR’s own delta vs base remains the quickstart page plus nav/home/pools callout wiring above. Still documentation-only; blast radius unchanged.

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

Comment only — already approved and risk did not increase, so approval is not dismissed and is not re-issued. No reviewers assigned.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@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

Verdict: Very Low risk — prior approval retained (risk did not increase after synchronize).

Evidence (from diff only)

File Change
quickstart.mdx New Mintlify docs page (install → drive browser → pools walkthrough with TS/Python/Go 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

Re-evaluation after update

Previously approved at 77c3e06. New HEAD 8d2a43c merges latest base (hypeship/browser-pools-docs-refresh). Relative to the last assessed tip (2b7711c), the merge only updates browsers/pools.mdx with base-branch wording (opening definition). This PR’s own delta vs base remains the quickstart page plus nav/home/pools callout wiring above. Still documentation-only; blast radius unchanged.

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

Comment only — already approved and risk did not increase, so approval is not dismissed and is not re-issued. No reviewers assigned.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

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.

1 participant