Docs: WSLC prerequisites omit Virtual Machine Platform; npm package accepts Node versions too old for Windows
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown, node.js
- Domain
- build-system, documentation
Research direction
Read docs/backends/wslc/wsl-container-getting-started.md and sdk/node/package.json, then compare the prerequisite table and npm engines value with the Node minimums documented in the README files. Update both entries to match the suggestions, and verify the docs mention admin rights and a reboot for Virtual Machine Platform.
Written by the indexing model from the issue text.
Description
Brief description of your issue
Two small prerequisite gaps:
1. WSLC getting-started guide (docs/backends/wslc/wsl-container-getting-started.md). The Prerequisites table lists
the Windows version, WSL 3.0.3+, the WSLC SDK and container images, but not the Virtual Machine Platform optional
feature. It is mentioned only in explanatory text and the Troubleshooting table. After following the guide on a PC
without it, wxc-exec --setup-wslc fails:
wslc setup failed: WSLC runtime unavailable. Missing components: VirtualMachinePlatform (0x1). Please enable the
"Virtual Machine Platform" Windows optional feature ...
The error is clear, but enabling the feature needs admin rights and a reboot, which is worth knowing up front.
Suggestion: add it to the Prerequisites table with "admin + reboot".
2. npm package engines. sdk/node/package.json declares "engines": {"node": ">=24.0.0"}, while the README and
Node SDK README say Windows needs Node 24.21.0+ (or 26.8.0+). npm install @microsoft/mxc-sdk on Node 24.15 gives no
warning. Suggestion: tighten engines to match the documented minimum.
Checked on main and the 1.0.1 package on 2026-10-30.
- Dominant language
- Rust
- Stars
- 3.1k
- Forks
- 171
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 86
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/mxc
-
Backend-IsolationSession Issue-Docs OS-Windows
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 2 days
-
Backend-IsolationSession Issue-Bug OS-Windows
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 2 days
-
Backend-Seatbelt Issue-Docs
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 2 days
-
Area-Node-SDK Issue-Task
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 2 days
-
Area-Build Issue-Bug OS-Windows
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 2 days
Similar issues
-
An EXE started from the shell with MAXALLOC FFFFh leaves a 0-paragraph free block after its ownOpenbug low-priority
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
dividebysandwich/rust-dos#629 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
eliasstravik/herdr-projects#758 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement needs:sonnet ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day