Skip to content

Add Create, Control, Observe introduction guides#370

Open
ehfeng wants to merge 5 commits into
mainfrom
hypeship/intro-create-control-observe
Open

Add Create, Control, Observe introduction guides#370
ehfeng wants to merge 5 commits into
mainfrom
hypeship/intro-create-control-observe

Conversation

@ehfeng
Copy link
Copy Markdown
Contributor

@ehfeng ehfeng commented May 20, 2026

Summary

Adds three high-level concept guides under the Introduction group to orient new users around Kernel's core surface area:

  • Create (introduction/create.mdx) — spinning up a browser, picking the right shape (headless, stealth, GPU, profiles), and lifecycle.
  • Control (introduction/control.mdx) — the two ways to drive a browser: computer controls (model-native, vision loops) vs Playwright execution (DOM, full-page screenshots). Includes a when-to-use-which table and the recommended pattern of using both together.
  • Observe (introduction/observe.mdx) — live view, replays, screenshots, and invocation logs, framed by what each is good for.

docs.json is updated to rename the first nav group from home to Introduction and add the three new pages alongside index.

Preview

Once Mintlify builds: https://tbd-6fc993ce-hypeship-intro-create-control-observe.mintlify.app/introduction/create (and /control, /observe).

Test plan

  • mintlify dev renders the three new pages
  • All cross-page links resolve (anchors verified against current H2/H3s)
  • Sidebar shows "Introduction" group with index + three new pages in order

Note

Low Risk
Low risk documentation-only change; main risk is broken internal links/navigation if any references to the removed browsers/create-a-browser page were missed despite the new redirect.

Overview
Adds three new high-level Introduction guides: introduction/create (browser creation + lifecycle), introduction/control (computer controls vs CDP/WebDriver + Playwright execution pattern), and introduction/observe (live view, replays, screenshots, logs).

Removes browsers/create-a-browser.mdx and updates docs-wide references (FAQ, integrations, scaling guide, changelog, homepage cards) to point to the new introduction/* pages, plus a docs.json nav reorg and a redirect from /browsers/create-a-browser to /introduction/create.

Clarifies standby/termination semantics by defining “activity” sources in browsers/standby and tying timeout start in browsers/termination to entering standby (including WebDriver and computer-controls activity).

Reviewed by Cursor Bugbot for commit c5fd931. Bugbot is set up for automated code reviews on this repo. Configure here.

Introduce three high-level concept guides under the Introduction
group that orient new users around the core surface area: creating
browsers, driving them (computer controls vs playwright execution),
and observing them (live view, replays, screenshots, logs).
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 20, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview May 20, 2026, 7:36 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

cursor[bot]
cursor Bot approved these changes May 20, 2026
Copy link
Copy Markdown

@cursor cursor Bot left a comment

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

The current diff is limited to documentation and navigation: new introduction/create, introduction/control, and introduction/observe MDX pages, a small docs.json sidebar update, and wording clarifications in browsers/standby.mdx and browsers/termination.mdx. I found no production codepaths, infrastructure, auth/security, data, prompt/instruction files, or shared runtime behavior changes.

No CODEOWNERS file was present in the repo. The PR is already approved at the current head commit, so I’m not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

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

The current diff is limited to documentation and Mintlify navigation: three new introduction/* MDX guides, a redirect/sidebar update in docs.json, link retargeting from the removed browsers/create-a-browser.mdx page, and small wording clarifications for standby/termination behavior. The .docs/code-example-guide.md change only updates a reference to the moved guide path.

I found no production codepaths, shared runtime behavior, infrastructure, auth/security, data/schema changes, or non-trivial prompt/instruction changes. No CODEOWNERS file was present. GitHub already reports this PR as approved, so I’m not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@masnwilliams masnwilliams marked this pull request as ready for review May 21, 2026 04:02
@firetiger-agent
Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

Any PR that changes the kernel API. Monitor changes to API endpoints (packages/api/cmd/api/) and Temporal workflows (packages/api/lib/temporal) in the kernel repo

Reason: PR only adds documentation guides and updates docs.json; no changes to API endpoints or Temporal workflows.

To monitor this PR anyway, reply with @firetiger monitor this.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low

The current diff is limited to Mintlify documentation changes: new introduction/create, introduction/control, and introduction/observe guides, removal of the old browsers/create-a-browser page with a redirect to introduction/create, navigation updates in docs.json, link retargeting, and small wording clarifications for standby/termination behavior.

I found no production codepaths, infrastructure, auth/security, data/schema changes, or shared runtime behavior changes. The only .docs change updates a reference path in the code example guide, which is a trivial documentation-maintenance edit. No CODEOWNERS file was present.

GitHub already reports this PR as approved, so I’m leaving this assessment as a comment and not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 4e62b81. Configure here.

Comment thread introduction/control.mdx Outdated

<Tabs>
<Tab title="Computer Controls">
OS-level mouse, keyboard, and screen — the primitives a computer-use model already speaks (screenshot, click, type, key, scroll, drag). No CDP or WebDriver connection required, so there's no protocol fingerprint to leak. Ideal for [Claude](/integrations/computer-use/anthropic), [OpenAI](/integrations/computer-use/openai), or [Gemini](/integrations/computer-use/gemini) computer-use loops.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Third-party AI product names used instead of generic terms

Low Severity

The new introduction/control.mdx page names specific third-party AI products — "Claude", "OpenAI", "Gemini", and "Anthropic" — directly in the documentation text. The project rule requires vendor-neutral, generic terms (e.g. "computer-use models" or "your preferred model provider") instead of specific product names. This appears on line 10 ("Ideal for [Claude]… [OpenAI]… or [Gemini] computer-use loops") and line 163 ("drop-in examples for Anthropic, Gemini, OpenAI, and more").

Additional Locations (1)
Fix in Cursor Fix in Web

Triggered by learned rule: Use generic terms instead of specific third-party AI product names

Reviewed by Cursor Bugbot for commit 4e62b81. Configure here.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low

I re-evaluated the current head diff (c5fd931). The changes remain limited to Mintlify documentation and navigation: new introduction/create, introduction/control, and introduction/observe guides, removal of the old browsers/create-a-browser page with a redirect, link retargeting, and small wording clarifications around standby/termination and “computer use.”

I found no production codepaths, infrastructure, auth/security, data/schema changes, or shared runtime behavior changes. The .docs/code-example-guide.md edit is only a reference-path update. I also found no CODEOWNERS file in the repo.

GitHub already reports this PR as approved, and this update does not increase the risk, so I’m leaving this as a comment and not submitting another approval.

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.

2 participants