Skip to content

Updates UV documentation to be experimental#4428

Merged
kellyguo11 merged 2 commits intoisaac-sim:mainfrom
kellyguo11:uv-experimental
Jan 22, 2026
Merged

Updates UV documentation to be experimental#4428
kellyguo11 merged 2 commits intoisaac-sim:mainfrom
kellyguo11:uv-experimental

Conversation

@kellyguo11
Copy link
Copy Markdown
Contributor

Description

Since UV is a relatively new installation method that has not yet gone through rigorous testing, this PR marks it as an experimental approach until we have fully tested the various installation methods.

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 the documentation Improvements or additions to documentation label Jan 20, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Jan 20, 2026

Greptile Overview

Greptile Summary

This PR appropriately marks UV as an experimental installation method by reordering documentation tabs and adding "(experimental)" labels.

Key changes:

  • Reordered virtual environment tabs in installation guides: Conda first, venv second, UV last
  • Added "(experimental)" designation to all UV tab labels across three documentation files
  • No functional code changes, only documentation reorganization

The changes are consistent and well-executed. The tab reordering successfully deprioritizes UV while keeping it available for users who want to try the newer package manager.

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Documentation-only change that correctly reorganizes virtual environment installation tabs and adds experimental labels without any functional impact
  • No files require special attention

Sequence Diagram

sequenceDiagram
    participant User as Documentation User
    participant Docs as Documentation Files
    participant VenvChoice as Environment Choice
    
    User->>Docs: Read installation guide
    Docs->>VenvChoice: Present environment options
    Note over VenvChoice: Tab order changed:<br/>1. Conda (stable)<br/>2. venv (standard)<br/>3. UV (experimental)
    VenvChoice->>User: Show Conda first (recommended)
    VenvChoice->>User: Show venv second (standard)
    VenvChoice->>User: Show UV last with experimental label
    User->>VenvChoice: Select preferred environment
    VenvChoice->>User: Provide installation instructions
Loading

Copy link
Copy Markdown
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.

No files reviewed, no comments

Edit Code Review Agent Settings | Greptile

@kellyguo11 kellyguo11 merged commit 215da03 into isaac-sim:main Jan 22, 2026
10 of 11 checks passed
nitesh-subedi pushed a commit to nitesh-subedi/IsaacLab that referenced this pull request Feb 5, 2026
# Description

Since UV is a relatively new installation method that has not yet gone
through rigorous testing, this PR marks it as an experimental approach
until we have fully tested the various installation methods.

## 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
- [ ] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->
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.

1 participant