Skip to content

docs(setup): remove nvm alias step from the Windows tab - #6852

Merged
kovtcharov-amd merged 1 commit into
amd:mainfrom
ityashag:docs/nvm-windows-default
Nov 6, 2026
Merged

docs(setup): remove nvm alias step from the Windows tab#6852
kovtcharov-amd merged 1 commit into
amd:mainfrom
ityashag:docs/nvm-windows-default

Conversation

@ityashag

@ityashag ityashag commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Removes the nvm alias default 20.20.0 step from the Windows tab of the setup guide, because NVM for Windows has no alias command.

Why

A Windows reader who follows this optional step gets a usage/help dump instead of a default-version change. The line is a copy of the POSIX nvm-sh syntax used in the Linux tab.

The step isn't needed on Windows. As #3225 notes, nvm use <version>, already in the guide just above it, persists the selection.

Linked issue

Closes #3225

Changes

  • Removes the "Set as default version (optional)" step from the Windows tab in docs/setup.mdx.
  • Leaves the Linux tab unchanged, because nvm-sh does support alias.

Test plan

  • grep -n "nvm alias default" docs/setup.mdx now matches only the Linux tab.
  • curl -sL https://raw.githubusercontent.com/coreybutler/nvm-windows/master/README.md | grep -ci "nvm alias" returns 0.
  • On Windows with NVM for Windows, run nvm alias default 20.20.0 to see the failure. I did not run this because I don't have a Windows environment set up for it. The issue documents that the command doesn't exist.

Evidence

N/A: this is a docs-only change. It doesn't touch the Agent UI, MCP tools, CLI behavior or the HTTP API.

  • Agent exposed in the Agent UI: N/A
  • MCP tools / servers: N/A
  • CLI: N/A
  • HTTP API / REST: N/A

Checklist

  • I have linked a GitHub issue above (Closes #N / Fixes #N / Refs #N).
  • I have described why this change is being made, not just what changed.
  • I have run linting and tests locally (python util/lint.py --all, pytest tests/unit/). Not run: this PR only removes lines from one .mdx file and changes no code.
  • I have attached real-world evidence matched to the surface I changed (see Evidence above), or marked it N/A with a reason.
  • I have updated documentation if user-visible behavior changed (see CONTRIBUTING.md). This PR is the documentation change.

@ityashag
docs(setup): remove nvm alias step from the Windows tab
f0c4922 
NVM for Windows has no alias command, so this optional step only prints a usage error. nvm use, already in the guide, persists the selection.

Closes amd#3225
@github-actions github-actions Bot added the documentation Documentation changes label Nov 6, 2026
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Verdict: Approve

The PR removes an optional "set as default version" step from the Windows setup instructions. That step used a command NVM for Windows doesn't have, so a Windows reader who ran it got a help dump instead of a default version. nvm use, which the guide already runs just above, keeps the chosen version on Windows, so nothing replaces the step. The Linux tab keeps its own alias line, which is correct there because nvm-sh supports it. No other doc tells Windows users to run nvm alias.

One follow-up, which doesn't block this PR: the requirements table at the top of the same page says Node.js 22 LTS, while both tabs install 20.20.0.

Real-world evidence

N/A: this PR only changes docs, so no evidence bundle was produced. The verdict rests on reading the change. The PR's own check that nvm alias appears nowhere in the NVM for Windows README backs up the reason for removing it.

🔍 Technical details

Issues found

  • 🟡 Follow-up: "Align the Node.js version in the setup guide's requirements table with the install steps" (docs/setup.mdx:21). The table lists 22 LTS via NVM, but the Windows steps (:80-81) and the Linux steps (:135-137) install 20.20.0. A reader sees two different versions on one page. This PR didn't cause it, so fix it here or file that issue.

Checks run

  • Docs drift: nvm alias now appears only at docs/setup.mdx:137, in the Linux/nvm-sh tab. No other page under docs/ gives Windows-specific nvm alias instructions.
  • The surrounding steps still read correctly: install, nvm use, then "Verify installation".

Strengths

  • The change is scoped to the one wrong line, and it correctly leaves the Linux tab alone.
  • The PR body cites the issue and the upstream README instead of guessing.

@kovtcharov-amd
kovtcharov-amd added this pull request to the merge queue Nov 6, 2026
Merged via the queue into amd:main with commit d39eb03 Nov 6, 2026
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kovtcharov-amd kovtcharov-amd Awaiting requested review from kovtcharov-amd kovtcharov-amd is a code owner

Assignees

No one assigned

Labels

documentation Documentation changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

The Windows tab tells readers to run nvm alias default 20.20.0, but NVM for Windows has no alias command

2 participants

@ityashag @kovtcharov-amd