Skip to content

docs: align documented prerequisites with current SDK requirements - #120

Merged
nicknisi merged 1 commit into
mainfrom
docs/doc-593-prerequisites
Sep 11, 2026
Merged

docs: align documented prerequisites with current SDK requirements#120
nicknisi merged 1 commit into
mainfrom
docs/doc-593-prerequisites

Conversation

@mitch-fultz

Copy link
Copy Markdown
Contributor

Why

The README currently advertises lower Node.js and TanStack Start versions than the SDK accepts. Align the three prerequisite values with the existing released requirements:

  • Opening TanStack Start requirement: v1.0+v1.168.25+.
  • Framework Compatibility TanStack Start requirement: v1.132.0+v1.168.25+.
  • Framework Compatibility Node.js requirement: 18+22.11.0+.

This is a documentation-only correction, not a runtime or compatibility-policy change. Package constraints, examples, Router/React entries, and all other files are unchanged. No version bump or SDK release is included.

Verified source

Rechecked September 11, 2026: current main package.json, v0.11.0 package.json, npm latest metadata, and the integrity-verified published 0.11.0 tarball all declare Node >=22.11.0 and @tanstack/react-start >=1.168.25.

#101 raised Start for the required .validator() API; #107 raised Node to match the WorkOS Node SDK. This updates the prose those changes left behind.

Validation

  • Native formatter and lint checks pass.
  • SDK build and typecheck pass.
  • All 250 tests across 21 files pass with coverage.
  • Example build and client bundle leak check pass.
  • git diff --check passes; only the three README prose values change.

Validated locally with Node 24.21.0 and pnpm 10.34.5. Normal CI and code-owner review remain required.

Tracking and publication

Partial implementation of DOC-593, related to TARS-1411 and AI-1929. Keep DOC-593 open until the normal SDK README sync, docs publication, shared-index readback, and fresh setup answer are verified.

The existing WorkOS SDK README sync reads upstream main; no npm release is needed for canonical docs. The already-published 0.11.0 tarball remains immutable. No generated mirror or Ask changes are included, and the unattended docs-only merge grant is not expanded. DOC-587 remains the separate ongoing MFA proof case.

@linear-code

linear-code Bot commented Sep 11, 2026

Copy link
Copy Markdown

DOC-593

TARS-1411

AI-1929

@greptile-apps

greptile-apps Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

The documentation-only change appears safe to merge.

Summary

  • Raises the documented TanStack Start minimum to v1.168.25+ in both prerequisite locations.
  • Raises the documented Node.js minimum to 22.11.0+.
  • Makes no runtime, dependency, or compatibility-policy changes.

Reviews (1) · Last reviewed commit: "docs: align documented prerequisites wit..."

@mitch-fultz

Copy link
Copy Markdown
Contributor Author

@workos/typescript — please review this three-value README correction for DOC-593. It aligns the documented Node/Start minimums with the existing released SDK metadata; no runtime behavior, package constraints, or examples change.

Nick Nisi and Garen Torikian have direct review requests. GitHub rejected the team's formal review request with HTTP 422 (“Reviews may only be requested from collaborators”), so I’m recording the team request here without changing repository permissions or bypassing code-owner review.

@nicknisi
nicknisi merged commit 3ea78ba into main Sep 11, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants