Skip to content

Updates the Path to Isaaclab Dir in SkillGen Documentation#3483

Merged
kellyguo11 merged 1 commit into
isaac-sim:release/2.3.0from
njawale42:neel/skillgen_doc_fix_release_v1
Sep 18, 2025
Merged

Updates the Path to Isaaclab Dir in SkillGen Documentation#3483
kellyguo11 merged 1 commit into
isaac-sim:release/2.3.0from
njawale42:neel/skillgen_doc_fix_release_v1

Conversation

@njawale42

Copy link
Copy Markdown
Contributor

Updates the path to IsaacLab directory in SkillGen documentation

Description

This PR updates the IsaacLab workspace path for clarity and consistency in SkillGen documentation.

  • Updated docs/source/overview/imitation-learning/skillgen.rst (Download and Setup section)
  • Replaced:
    • Before: cd /path/to/your/isaaclab/root
    • After: cd /path/to/your/IsaacLab

Motivation: Aligns with the repository name and common workspace convention, reducing confusion and preventing copy-paste errors for users following setup steps.

Dependencies: None

Type of change

  • Documentation update

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

@njawale42 njawale42 added the documentation Improvements or additions to documentation label Sep 17, 2025
@njawale42 njawale42 changed the title Isaaclab dir path fix in SkillGen docs Update the Path to Isaaclab Dir in SkillGen Documentation Sep 17, 2025
@kellyguo11 kellyguo11 changed the title Update the Path to Isaaclab Dir in SkillGen Documentation Updates the Path to Isaaclab Dir in SkillGen Documentation Sep 18, 2025
@kellyguo11 kellyguo11 merged commit bdb690e into isaac-sim:release/2.3.0 Sep 18, 2025
4 of 6 checks passed
hougantc-nvda pushed a commit to hougantc-nvda/IsaacLab that referenced this pull request Nov 10, 2025
…#3483)

# Updates the path to IsaacLab directory in SkillGen documentation

## Description

This PR updates the IsaacLab workspace path for clarity and consistency
in SkillGen documentation.

- Updated `docs/source/overview/imitation-learning/skillgen.rst`
(Download and Setup section)
- Replaced:
  - Before: `cd /path/to/your/isaaclab/root`
  - After: `cd /path/to/your/IsaacLab`

Motivation: Aligns with the repository name and common workspace
convention, reducing confusion and preventing copy-paste errors for
users following setup steps.

Dependencies: None

## Type of change

- Documentation update

## Checklist

- [x] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [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
- [ ] 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
- [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.

2 participants