Skip to content

docs: clarify Windows commands run in Command Prompt, not PowerShell#5736

Open
SAY-5 wants to merge 2 commits into
isaac-sim:mainfrom
SAY-5:docs/windows-cmd-prompt
Open

docs: clarify Windows commands run in Command Prompt, not PowerShell#5736
SAY-5 wants to merge 2 commits into
isaac-sim:mainfrom
SAY-5:docs/windows-cmd-prompt

Conversation

@SAY-5
Copy link
Copy Markdown

@SAY-5 SAY-5 commented May 21, 2026

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 like set and mklink work as documented.

Per @RandomOakForest in #5552:

Following up, if you have time for a PR, please submit it. The team will review it and will aim to merge it.

Fixes #5552

Type of change

  • Documentation update

Screenshots

N/A (text-only addition).

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

Note: this is a docs-only change (two RST files, no code, no extension touched), so the pre-commit, tests, changelog and extension version items above are not applicable. Happy to also add a CONTRIBUTORS.md entry in a follow-up if maintainers prefer.

Signed-off-by: Sai Asish Y <say.apm35@gmail.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 21, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 21, 2026

Greptile Summary

This PR adds a short .. note:: directive in the Windows section of the "Verifying the Isaac Sim installation" heading in both the pre-built binaries and source installation guides, alerting users to run Windows commands in cmd.exe rather than PowerShell.

  • Both RST files receive the identical note block; wording is clear, technically accurate, and uses correct RST formatting (.. note:: with proper indentation).
  • Placement is appropriate in both files — the cmd.exe-specific commands (set, mklink) appear immediately after the inserted note in each guide.

Confidence Score: 5/5

Safe 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 .. note:: directive with proper indentation. The note content (set and mklink not working in PowerShell) is factually correct, and placement immediately before the first batch of cmd.exe commands is appropriate in both guides.

No files require special attention.

Important Files Changed

Filename Overview
docs/source/setup/installation/binaries_installation.rst Adds a .. note:: block under "Verifying the Isaac Sim installation" clarifying that Windows tabs use cmd.exe syntax, not PowerShell. Placement is appropriate — the first set commands appear immediately after the note.
docs/source/setup/installation/source_installation.rst Same note block added under "Verifying the Isaac Sim installation". The build.bat Windows command shown earlier in the "Building from source" section works fine in either shell, so the note's placement after that section is still accurate.

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
Loading

Reviews (1): Last reviewed commit: "docs: clarify Windows commands run in Co..." | Re-trigger Greptile

Copy link
Copy Markdown

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 Isaac Lab Review Bot — Multi-Perspective Analysis

PR: #5736docs: 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)

  1. 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 set commands appear immediately after.

  2. PowerShell equivalent hint: A brief parenthetical like "($env:VAR in 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Proposal] Clarify Windows shell requirement (Command Prompt) in installation docs

1 participant