Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates documentation on Isaac Lab installation path for Windows #1271

Merged
merged 4 commits into from
Oct 25, 2024

Conversation

louislelay
Copy link
Contributor

Description

This update addresses a minor inconsistency found in the Isaac Lab installation documentation for Windows.

While following the installation instructions on Isaac Lab for "Option 2: Installation using Isaac Sim binaries" on Windows, I encountered the following lines:

C:\Users\%USERPROFILE%\AppData\Local\ov\pkg\isaac_sim-*, with * corresponding to the Isaac Sim version.

set ISAACSIM_PATH="C:\Users\%USERPROFILE%\AppData\Local\ov\pkg\isaac-sim-4.2.0"

This seemed redundant, as %USERPROFILE% already refers to the path C:\Users\name_of_user.

I have compiled and verified the documentation changes to ensure proper display. Additionally, I tested this update on a Windows system, confirming that it works as intended.

Type of change

  • This change requires a documentation update

Checklist

  • 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

@Mayankm96 Mayankm96 added the documentation Improvements or additions to documentation label Oct 23, 2024
Signed-off-by: David Hoeller <dhoeller@nvidia.com>
Signed-off-by: David Hoeller <dhoeller@nvidia.com>
Copy link
Collaborator

@Dhoeller19 Dhoeller19 left a comment

Choose a reason for hiding this comment

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

Thanks @louislelay!

@Dhoeller19 Dhoeller19 changed the title Update to Documentation on Isaac Lab Installation Path for Windows Updates documentation on Isaac Lab installation path for Windows Oct 24, 2024
@Dhoeller19 Dhoeller19 merged commit 4c91535 into isaac-sim:main Oct 25, 2024
5 checks passed
iamdrfly pushed a commit to iamdrfly/IsaacLab that referenced this pull request Nov 21, 2024
…ac-sim#1271)

# Description

This update addresses a minor inconsistency found in the Isaac Lab
installation documentation for Windows.

While following the installation instructions on Isaac Lab for "Option
2: Installation using Isaac Sim binaries" on Windows, I encountered the
following lines:

> `C:\Users\%USERPROFILE%\AppData\Local\ov\pkg\isaac_sim-*`, with `*`
corresponding to the Isaac Sim version.

> `set
ISAACSIM_PATH="C:\Users\%USERPROFILE%\AppData\Local\ov\pkg\isaac-sim-4.2.0"`

This seemed redundant, as `%USERPROFILE%` already refers to the path
`C:\Users\name_of_user`.

I have compiled and verified the documentation changes to ensure proper
display. Additionally, I tested this update on a Windows system,
confirming that it works as intended.

## Type of change

- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
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.

3 participants