Skip to content

docs: link runtime prerequisites instead of restating versions - #2518

Merged
SteveSandersonMS merged 1 commit into
github:mainfrom
rinceyuan:docs/link-runtime-prerequisites
Sep 4, 2026
Merged

docs: link runtime prerequisites instead of restating versions#2518
SteveSandersonMS merged 1 commit into
github:mainfrom
rinceyuan:docs/link-runtime-prerequisites

Conversation

@rinceyuan

Copy link
Copy Markdown
Contributor

Summary

The getting-started prerequisites say Node.js 20+, but the Node SDK declares:

"engines": { "node": "^20.19.0 || >=22.12.0" }

So 20.0-20.18 and all of 21.x are unsupported, and a reader who follows this page onto one of them hits EBADENGINE at install time. nodejs/README.md already states the real constraint, so the list on this page had simply drifted.

Rather than correcting the number and leaving a second copy to drift again, this points each language at the Prerequisites section of its own README - the same thing docs/setup/bundled-cli.md now does. That keeps one source of truth per SDK.

Verification

  • All six targets exist and expose a ## Prerequisites heading, and the ../<lang>/README.md paths resolve from docs/.
  • Current floors, for reference: Node ^20.19.0 || >=22.12.0, Python >=3.11, Go 1.24, Rust 1.94.0, Java 17 (JDK 25 recommended), .NET any .NET Standard 2.0-compatible implementation. The removed line also understated .NET, which targets netstandard2.0 in addition to net8.0/net10.0.
  • Prose only, no code blocks touched, so docs-validate is unaffected.

The getting-started prerequisites listed 'Node.js 20+', but the Node SDK requires '^20.19.0 || >=22.12.0', so 20.0-20.18 and all of 21.x fail to install. nodejs/README.md already states the real constraint.

Point each language at the Prerequisites section of its own README, matching how docs/setup/bundled-cli.md now refers to them, so there is one place per SDK to keep current.
Copilot AI balanced review requested due to automatic review settings September 4, 2026 06:41
@rinceyuan
rinceyuan requested a review from a team as a code owner September 4, 2026 06:41

Copilot AI 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.

🟢 Approval recommended

All links resolve to prerequisite sections that state the relevant runtime requirements.

Pull request overview

Replaces duplicated runtime versions with links to each SDK’s authoritative prerequisites.

Changes:

  • Links all six language SDK prerequisite sections.
  • Prevents runtime requirements from drifting across documentation.
File summaries
File Description
docs/getting-started.md References SDK-specific runtime prerequisites.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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

Verified: nodejs/package.json requires ^20.19.0 || >=22.12.0, so the old "Node.js 20+" line in getting-started.md was inaccurate (20.0-20.18 and 21.x actually fail with EBADENGINE), and the .NET line was similarly off. Confirmed all six linked README.md#prerequisites anchors resolve, and this matches the existing pattern in docs/setup/bundled-cli.md. Small, correct, prose-only fix. Approving.

@SteveSandersonMS
SteveSandersonMS added this pull request to the merge queue Sep 4, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to no response for status checks Sep 4, 2026
@SteveSandersonMS
SteveSandersonMS added this pull request to the merge queue Sep 4, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Sep 4, 2026
@SteveSandersonMS
SteveSandersonMS added this pull request to the merge queue Sep 4, 2026
@SteveSandersonMS
SteveSandersonMS removed this pull request from the merge queue due to a manual request Sep 4, 2026
@SteveSandersonMS
SteveSandersonMS merged commit d5f95df into github:main Sep 4, 2026
28 checks passed
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