Skip to content

Restructure How it works: Configure, Control, Scale, Observe, Manage - #671

Merged
andrewleesteele merged 1 commit into
mainfrom
hypeship/ia-how-it-works
Oct 7, 2026
Merged

andrewleesteele merged 1 commit into
mainfrom
hypeship/ia-how-it-works

Conversation

@andrewleesteele

@andrewleesteele andrewleesteele commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

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

  • New overview covering browser creation, browser types (headful, headless, GPU), viewport, standby, and timeouts. The individual browser setting pages leave the sidebar and are linked from it.
  • Stealth, Proxies, Profiles, Vaults, Authentication, Payments, Config Registry.
  • Authentication nests the managed auth pages in their own group. Managed Auth Credentials is merged into Configuration (redirected), and the managed auth overview gets a connection options table.
  • The hCaptcha beta page folds into Stealth Mode (redirected). Vaults gets a credential-source comparison. Link by Stripe and AgentCard titles fixed.

Control

  • Overview leads with the control surface choice (now including WebMCP and the REPL) and where the loop runs. The "why" sections move into the computer controls and Playwright execution pages.
  • Sidebar: Playwright Execution, Computer Controls, WebMCP, Browser REPL, Process Execution, File I/O, Code Execution Platform. Curl and SSH are linked from the overview. Browser REPL gets its own tab under where the loop runs.
  • Code execution platform: secrets folds into Deploy and stopping into Invoke (both redirected); pages get task titles.

Scale

  • Overview leads with limits and performance, then the on-demand versus pool decision with on-demand as the default.
  • New Concurrency and Limits page holds every per-plan limit and the API rate limits; links to the old pricing anchors point at it.

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

Testing

  • mint validate and mint broken-links pass on this branch.
  • Rendered locally to check the Configure, Control, Scale, Observe, and Manage overviews.

🤖 Generated with Claude Code


Note

Low Risk
Documentation and navigation-only changes with redirects for moved pages; no runtime product code.

Overview
Restructures the Guides sidebar around a new How it works flow: Configure, Control, Scale, Observe, and Manage, each with an overview page and regrouped child docs in docs.json.

Configure adds introduction/configure.mdx as the browser-setup hub; stealth, proxies, profiles, vaults, auth, payments, and config registry sit under it. Managed Auth Credentials (auth/credentials.mdx) is folded into Connection Configuration with redirects; apps/secrets and apps/stop move into Deploy and Invoke (with redirects). hCaptcha content merges into stealth (standalone page removed).

Control rewrites introduction/control.mdx around control surface vs where the agent loop runs; code execution platform pages get clearer titles/descriptions. Scale adds browsers/concurrency-and-limits.mdx and retargets concurrency/rate-limit links from pricing anchors. Observe groups telemetry under a sidebar subsection; Manage adds introduction/manage.mdx and moves projects, API keys, audit logs, and firewall allowlist there.

Cross-cutting: overview titles/sidebarTitle/description front matter, sentence-case headings, eyebrow.js to hide duplicate section eyebrows, seo.indexing, changelog link fixes, and vault credential-source comparison on vaults/overview.mdx.

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

@mintlify

mintlify Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
Kernel 🟢 Ready View Preview Oct 7, 2026, 6:23 PM

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

@andrewleesteele
andrewleesteele added this pull request to stack #675 October 5, 2026 19:58
@andrewleesteele andrewleesteele changed the title hypeship/ia how it works Restructure How it works: Configure, Control, Scale, Observe, Manage Oct 5, 2026
@dprevoznik
dprevoznik marked this pull request as ready for review October 5, 2026 21:15

@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 Bugbot comment from a previous run.

Comment thread introduction/configure.mdx
Comment thread apps/develop.mdx Outdated
Comment thread browsers/concurrency-and-limits.mdx

@dprevoznik dprevoznik left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Left some comments!

Comment thread introduction/configure.mdx Outdated
Comment thread introduction/configure.mdx Outdated
Comment thread introduction/control.mdx Outdated
Comment thread introduction/control.mdx Outdated
Comment thread introduction/control.mdx Outdated
Comment thread introduction/control.mdx
Comment thread browsers/browser-loop.mdx Outdated

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

Cursor Bugbot has reviewed your changes using default effort and found 3 potential issues.

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 18ca8c3. Configure here.


Often agents don't require these, but they're there when you do:

- **[Regions](/browsers/regions):** run browsers in `us-east`, `eu-west`, or `ap-southeast`, closer to your code and your users.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Configure copies region codes

Medium Severity

The new Configure overview inlines the shipped region codes us-east, eu-west, and ap-southeast instead of only linking to the canonical Regional Browsers page.

Fix in Cursor Fix in Web

Triggered by learned rule: Regional browsers: latency not residency; canonical /browsers/regions

Reviewed by Cursor Bugbot for commit 18ca8c3. Configure here.

Comment thread browsers/concurrency-and-limits.mdx
Comment thread docs.json

@AnnaXWang AnnaXWang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I really like this - can we double check that old links will automatically redirect to new links?

Copy link
Copy Markdown
Contributor Author

Yes, every link that works today will keep working!

@andrewleesteele

Copy link
Copy Markdown
Contributor Author

@AnnaXWang yes, checked against the deployed preview for the full stack:

  • Pages: every page URL on main and every redirect source (260 URLs) resolves. The two exceptions, /llm.md and /llm-browser.md, already 404 on production today and aren't touched by this stack.
  • Removed or merged pages redirect to where their content moved:
    • /apps/secrets → /apps/deploy#secrets
    • /apps/stop → /apps/invoke#stop-an-invocation
    • /auth/credentials → /auth/configuration#credentials-and-auto-reauth
    • /browsers/bot-detection/hcaptcha → /browsers/bot-detection/stealth#hcaptcha-beta
    • /integrations/vercel/foreman → /cookbooks/eve-foreman
  • Pages that left the sidebar keep their URLs, including integration, skill, and browser settings pages.
  • Section anchors: where a heading was renamed or moved, the old #anchor is kept as a hidden anchor on the new section. For example, /info/pricing#rate-limiting and /introduction/scale#why-a-browser-pool still land on the right section.

One limit: a link into a sub-section of a deleted page lands at the top of the section it redirects to, since a redirect carries a single fragment.

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

@dprevoznik dprevoznik left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@andrewleesteele
andrewleesteele merged commit 8e7dcda into main Oct 7, 2026
3 checks passed
@andrewleesteele
andrewleesteele deleted the hypeship/ia-how-it-works branch October 7, 2026 18:44

This branch was successfully deployed

1 active deployment
staging — 8bdac1dd Deployed Oct 7, 2026 by mintlify[bot]
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.

3 participants