Skip to content

docs: clarify Node version requirements#2128

Open
asim48-ctrl wants to merge 1 commit into
browserbase:mainfrom
asim48-ctrl:codex/stagehand-node-support-doc
Open

docs: clarify Node version requirements#2128
asim48-ctrl wants to merge 1 commit into
browserbase:mainfrom
asim48-ctrl:codex/stagehand-node-support-doc

Conversation

@asim48-ctrl
Copy link
Copy Markdown
Contributor

@asim48-ctrl asim48-ctrl commented May 15, 2026

why

The root package already declares the supported Node range as ^20.19.0 || >=22.12.0, but the source-build docs only said Node.js. That leaves contributors guessing which Node versions match the package engines, especially around the Node support discussion in #1995.

what changed

  • added the existing package engine range to the root source-build instructions
  • added the same Node range to the server-v4 local API prerequisites

test plan

  • git diff --check

No runtime tests; docs-only change.


Summary by cubic

Clarified Node.js version support in the docs to match our engines. Added ^20.19.0 || >=22.12.0 to the root build-from-source instructions and the server-v4 local API prerequisites.

Written for commit 811f3c7. Summary will update on new commits. Review in cubic

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 15, 2026

⚠️ No Changeset found

Latest commit: 811f3c7

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

@github-actions
Copy link
Copy Markdown
Contributor

This PR is from an external contributor and must be approved by a stagehand team member with write access before CI can run.
Approving the latest commit mirrors it into an internal PR owned by the approver.
If new commits are pushed later, the internal PR stays open but is marked stale until someone approves the latest external commit and refreshes it.

@github-actions github-actions Bot added external-contributor Tracks PRs mirrored from external contributor forks. external-contributor:awaiting-approval Waiting for a stagehand team member to approve the latest external commit. labels May 15, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 2 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.
Architecture diagram
sequenceDiagram
    participant User
    participant Repo as Repository
    participant Pkg as Package Config
    participant Doc as Documentation
    
    Note over User,Doc: Node Version Requirement Flow
    
    User->>Repo: Clone & build from source
    Repo->>Pkg: Read engines field
    Pkg-->>Repo: Node ^20.19.0 || >=22.12.0
    alt Documentation check
        Repo->>Doc: root README.md
        Doc-->>Repo: Now includes Node version
        Repo->>Doc: packages/server-v4/README.md
        Doc-->>Repo: Now includes Node version
    end
    User->>Doc: Review documented Node requirements
    Note over User: Satisfies engine constraint
    
    alt Node version mismatch
        User->>Pkg: Validate local Node version
        Pkg-->>User: Version check fails (EENGINE)
        User->>Doc: See documented requirements
        Doc-->>User: Must install correct Node version
    end
Loading

Re-trigger cubic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external-contributor:awaiting-approval Waiting for a stagehand team member to approve the latest external commit. external-contributor Tracks PRs mirrored from external contributor forks.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant