docs: clarify Windows commands run in Command Prompt, not PowerShell#5736
docs: clarify Windows commands run in Command Prompt, not PowerShell#5736SAY-5 wants to merge 2 commits into
Conversation
Signed-off-by: Sai Asish Y <say.apm35@gmail.com>
Greptile SummaryThis PR adds a short
Confidence Score: 5/5Safe to merge — two RST files, no code touched, note content is accurate and well-formed. Both changes are identical, minimal RST additions that correctly use the No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User opens Windows installation guide] --> B{Which shell?}
B -->|cmd.exe| C[Commands work as documented\nset, mklink, etc.]
B -->|PowerShell| D[Commands may fail\nor behave unexpectedly]
E[New note block added here] --> B
style E fill:#ffffcc,stroke:#cccc00
style C fill:#ccffcc,stroke:#00cc00
style D fill:#ffcccc,stroke:#cc0000
Reviews (1): Last reviewed commit: "docs: clarify Windows commands run in Co..." | Re-trigger Greptile |
There was a problem hiding this comment.
🤖 Isaac Lab Review Bot — Multi-Perspective Analysis
PR: #5736 — docs: clarify Windows commands run in Command Prompt, not PowerShell
Author: @SAY-5 | Commit: 3e8cbe68 | Files changed: 2
📋 Summary
This PR adds a .. note:: directive to both the binary and source installation guides, warning Windows users that the documented commands use Command Prompt (cmd.exe) syntax rather than PowerShell. This directly addresses the confusion reported in #5552.
✅ Verdict: LGTM
| Aspect | Assessment |
|---|---|
| Accuracy | ✅ Correct — set and mklink are indeed cmd.exe built-ins that behave differently (or fail) in PowerShell |
| Placement | ✅ Well-placed — appears at the top of "Verifying the Isaac Sim installation" in both guides, before users encounter those commands |
| RST Syntax | ✅ Valid .. note:: directive with correct indentation and blank lines |
| Consistency | ✅ Identical wording in both files ensures a uniform experience |
| Completeness | ✅ Covers both installation paths (binaries & source) |
| Grammar/Clarity | ✅ Clean, concise, no issues |
💡 Optional Suggestions (non-blocking)
-
Scope of note: The note says "throughout this guide" — since it's placed mid-page under "Verifying the Isaac Sim installation," users who scroll past it to later sections may miss it. Consider whether placing it even earlier (e.g., under the top-level prerequisites section) might catch more readers. However, the current placement is reasonable since
setcommands appear immediately after. -
PowerShell equivalent hint: A brief parenthetical like "(
$env:VARin PowerShell)" could help PowerShell users translate, but this is purely a nice-to-have and outside the scope of this PR.
🏁 CI Status
- ✅
labeler— passed
No findings requiring changes. Approving as documentation improvement.
Description
Adds a short note in the Windows tab of both the "Verifying the Isaac Sim installation" sections (pre-built binaries and source installation guides) calling out that the Windows commands shown throughout the guide use Command Prompt (
cmd.exe) syntax, not PowerShell, so commands likesetandmklinkwork as documented.Per @RandomOakForest in #5552:
Fixes #5552
Type of change
Screenshots
N/A (text-only addition).
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there