Skip to content

Conversation

@pascal-roth
Copy link
Collaborator

@pascal-roth pascal-roth commented Aug 27, 2025

Description

There have been two places where the template documentation has been placed (under Developers Guide and Workthrough), this PR unifies them into a new structure (see image below).

Furthermore, the imitation learning examples were missing a grouping, this PR introduces a structure similar to the section about reinforcement learning

Also some general docs fixes are included.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Screenshots

image

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 Aug 27, 2025
@pascal-roth
Copy link
Collaborator Author

@kellyguo11 and @Mayankm96 can we quickly merge that, would be nice so that no new user falls into the pitfall

@kellyguo11 kellyguo11 merged commit 8608fbc into isaac-sim:main Aug 29, 2025
8 checks passed
george-nehma pushed a commit to george-nehma/DreamLander-IsaacLab that referenced this pull request Oct 24, 2025
…m#3283)

# Description

There have been two places where the template documentation has been
placed (under Developers Guide and Workthrough), this PR unifies them
into a new structure (see image below).

Furthermore, the imitation learning examples were missing a grouping,
this PR introduces a structure similar to the section about
reinforcement learning

Also some general docs fixes are included.

## Type of change

- Bug fix (non-breaking change which fixes an issue)

## Screenshots

<img width="588" height="1323" alt="image"
src="https://github.com/user-attachments/assets/a17a6328-a9e3-44cd-a299-6aa62e0e422e"
/>

## 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
- [ ] My changes generate no new warnings
- [x] 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
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