Skip to content

docs: update to capture new defaults - #3446

Merged
akeimach merged 3 commits into
mainfrom
alyssamaruyama/ap-3163-docs-and-changelog-update-to-explain-cache-defaults
Nov 13, 2026
Merged

akeimach merged 3 commits into
mainfrom
alyssamaruyama/ap-3163-docs-and-changelog-update-to-explain-cache-defaults

Conversation

@akeimach

@akeimach akeimach commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

why

Update docs to describe new caching workflow

what changed

test plan


Summary by cubic

Updates the docs to reflect that server-side caching for Browserbase projects is now opt-in instead of on by default.

  • V3 and V4 guides and API references now explain that caching is off until a project requests it via Browserbase support.
  • The cache/serverCache options still work, but only after project-level enabling; cacheStatus is undefined when disabled.

Written for commit 2ddacfe. Summary will update on new commits.

View guided diff Turn on auto-fix

@akeimach
akeimach requested a review from a team as a code owner November 12, 2026 21:29
@changeset-bot

changeset-bot Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2ddacfe

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@cubic-dev-ai cubic-dev-ai Bot 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.

All reported issues were addressed across 15 files

Architecture diagram
sequenceDiagram
    participant Dev as Developer
    participant Docs as Stagehand Docs
    participant Support as Browserbase Support
    participant App as Stagehand App
    participant Browserbase as Browserbase Platform

    Note over Dev,Browserbase: NEW: Server-side caching is now opt-in per project

    Dev->>Docs: Read caching docs
    Docs-->>Dev: Caching requires project enablement

    Dev->>Support: Email request with project ID
    Support->>Browserbase: Enable caching for project
    Support-->>Dev: Caching enabled confirmation

    Dev->>App: Stagehand.create({ env: "BROWSERBASE" })
    App->>Browserbase: init browser session
    Browserbase-->>App: Session ready

    alt Caching enabled for project
        App->>App: act/extract/observe with cache option
        App->>Browserbase: Send request with cache key
        alt Cache hit
            Browserbase-->>App: cached result
            App-->>Dev: cacheStatus: "HIT"
        else Cache miss
            Browserbase->>Browserbase: Run LLM inference
            Browserbase-->>App: fresh result (cached server-side)
            App-->>Dev: cacheStatus: "MISS"
        end
    else Caching not enabled for project
        App->>Browserbase: Send request (no cache)
        Browserbase-->>App: result
        App-->>Dev: cacheStatus: undefined
    end

    Note over App,Browserbase: Locator-scoped calls bypass cache (status: DISABLED)
Loading

Tip: Get a Slack DM when cubic finishes reviewing your PRs. Connect Slack

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread packages/docs/v4/basics/act.mdx Resolved
Comment thread packages/docs/v3/basics/act.mdx Resolved
Comment thread packages/docs/v3/basics/extract.mdx Resolved
Comment thread packages/docs/v4/migrations/v3.mdx Resolved
@akeimach
akeimach merged commit 58a6cc1 into main Nov 13, 2026
24 checks passed
@akeimach
akeimach deleted the alyssamaruyama/ap-3163-docs-and-changelog-update-to-explain-cache-defaults branch November 13, 2026 04:11
akeimach added a commit that referenced this pull request Nov 13, 2026
# why

Update docs to describe new caching workflow

# what changed

# test plan

<!-- This is an auto-generated description by cubic. --> ---
## Summary by cubic
Updates the docs to reflect that server-side caching for Browserbase
projects is now opt-in instead of on by default.

- V3 and V4 guides and API references now explain that caching is off
until a project requests it via Browserbase support.
- The `cache`/`serverCache` options still work, but only after
project-level enabling; `cacheStatus` is `undefined` when disabled.

<sup>Written for commit 2ddacfe.
Summary will update on new commits.</sup>

<a

href="https://cubic.dev/pr/browserbase/stagehand/pull/3446?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="View guided diff"

src="https://www.cubic.dev/buttons/review-in-cubic-light.svg"></picture></a>
<a

href="https://www.cubic.dev/action/auto-fix/pr/browserbase/stagehand/3446?returnTo=https%3A%2F%2Fgithub.com%2Fbrowserbase%2Fstagehand%2Fpull%2F3446&source=description"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"

srcset="https://www.cubic.dev/buttons/turn-on-auto-fix-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/turn-on-auto-fix-light.svg"><img
alt="Turn on auto-fix"

src="https://www.cubic.dev/buttons/turn-on-auto-fix-light.svg"></picture></a>

<!-- End of auto-generated description by cubic. -->

# why

# what changed

# test plan
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