docs: align documented prerequisites with current SDK requirements - #120
Merged
Conversation
Contributor
|
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
approved these changes
Sep 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
v1.0+→v1.168.25+.v1.132.0+→v1.168.25+.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.0and@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
git diff --checkpasses; 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.