Skip to content

Conversation

@Mayankm96
Copy link
Contributor

@Mayankm96 Mayankm96 commented Nov 23, 2025

Description

This MR updates the docs to refer to the technical report of Isaac Lab. The acknowledgement to Orbit is kept but its reference has been purged. Future users should cite the technical report as it has the most updated description of features.

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

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 23, 2025
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Nov 23, 2025

Greptile Overview

Greptile Summary

Updated all documentation and citation files to reference the Isaac Lab technical report (arXiv:2511.04831) instead of the Orbit paper as the primary citation.

  • Updated CITATION.cff with new technical report details, extensive author list (100+ contributors), proper DOI, and corrected repository URL
  • Modified README.md and docs/index.rst to prominently feature the Isaac Lab paper with links to the arXiv preprint
  • Added new BibTeX entry to docs/source/_static/refs.bib while preserving the Orbit citation for backward compatibility
  • Repositioned Citation sections before Acknowledgement sections across documentation
  • Maintained acknowledgement to Orbit framework as the foundation of Isaac Lab development
  • Updated tasks.jpg image file

Confidence Score: 5/5

  • This PR is safe to merge with no risk - it only updates documentation and citation references
  • This is a straightforward documentation update with no code changes. All modifications correctly reference the new Isaac Lab technical report, maintain proper citation formats, preserve backward compatibility with the Orbit reference, and the arXiv link is accessible. The changes are consistent across all documentation files.
  • No files require special attention

Important Files Changed

File Analysis

Filename Score Overview
CITATION.cff 5/5 Updated citation file to reference Isaac Lab technical report with extensive author list and proper DOI
README.md 5/5 Added arXiv paper link, updated citation section with new technical report, moved Orbit acknowledgement to end
docs/index.rst 5/5 Updated documentation index to reference Isaac Lab technical report instead of Orbit paper
docs/source/_static/refs.bib 5/5 Added new BibTeX entry for Isaac Lab technical report while preserving Orbit citation
docs/source/_static/tasks.jpg 5/5 Updated tasks image (binary file change)

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant CFF as CITATION.cff
    participant README as README.md
    participant INDEX as docs/index.rst
    participant BIB as docs/source/_static/refs.bib
    participant IMG as docs/source/_static/tasks.jpg
    
    Dev->>CFF: Update citation message to reference Isaac Lab technical report
    Dev->>CFF: Change repository URL from NVIDIA-Omniverse to isaac-sim
    Dev->>CFF: Add DOI identifier for arXiv:2511.04831
    Dev->>CFF: Replace Orbit paper with Isaac Lab technical report
    Dev->>CFF: Expand author list (from ~12 to 100+ authors)
    
    Dev->>README: Add arXiv paper link in introduction
    Dev->>README: Update "16 commonly available models" to "more than 16"
    Dev->>README: Move Citation section before Acknowledgement
    Dev->>README: Replace Orbit citation with Isaac Lab citation
    Dev->>README: Update Acknowledgement to gratefully acknowledge Orbit
    
    Dev->>INDEX: Update framework reference link to Isaac Lab arXiv paper
    Dev->>INDEX: Change citation key from mittal2023orbit to mittal2025isaaclab
    Dev->>INDEX: Move Citation section before Acknowledgement
    Dev->>INDEX: Update citation BibTeX entry
    Dev->>INDEX: Update Acknowledgement text
    
    Dev->>BIB: Add new mittal2025isaaclab BibTeX entry
    Dev->>BIB: Keep existing mittal2023orbit entry for backward compatibility
    
    Dev->>IMG: Update tasks.jpg image file
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

4 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
@github-actions
Copy link

Test Results Summary

2 691 tests   2 230 ✅  2h 17m 17s ⏱️
  100 suites    461 💤
    1 files        0 ❌

Results for commit 21c921f.

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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants