Skip to content

Fix environment browser preview image URLs - #7849

Merged
kellyguo11 merged 1 commit into
isaac-sim:developfrom
StafaH:fix/environment-browser-preview-urls
Sep 16, 2026
Merged

kellyguo11 merged 1 commit into
isaac-sim:developfrom
StafaH:fix/environment-browser-preview-urls

Conversation

@StafaH

@StafaH StafaH commented Sep 16, 2026

Copy link
Copy Markdown
Collaborator

Description

Follow-up to #7822 that addresses the two review comments left on the merged PR:

  • resolve task-card thumbnails from the external task-image host instead of the deleted local _static/tasks assets; and
  • keep non-task preview images, such as Lift-Soft-Franka, on their local _static paths.

Both the selected-task preview and task-card thumbnails now use one shared URL resolver.

Addresses:

Type of change

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

Release backport

  • Backport this pull request to the active release branch after it merges into develop

Validation

  • node --check docs/source/_static/css/environment-browser.js
  • uv run --extra test python -m pytest --noconftest tools/test/test_environ_docs.py (35 passed)
  • uv run --isolated --extra dev -- make -C docs current-docs (succeeded without warnings)
  • Headless Chrome verified Cartpole resolves to the external task-image URL and Lift-Soft-Franka resolves to the local built _static/newton image.
  • uv run isaaclab -f (all applicable hooks passed; changelog validation passed separately against upstream/develop because the fork base is stale)

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Existing environment documentation tests pass
  • No source package was touched, so no changelog fragment is required
  • My name already exists in CONTRIBUTORS.md

@StafaH
StafaH requested a review from a team September 16, 2026 13:43
@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation labels Sep 16, 2026

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Isaac Lab Review Bot

The change centralizes environment-browser preview URL resolution so task images use the external image host while non-task images, including Lift-Soft-Franka, remain under the documentation build’s local _static path.

  • Design and architecture: Using one resolver for both selected-task previews and task-card thumbnails removes the previous divergence between their producer paths. Routing by the existing tasks/ prefix is consistent with the current image mapping table, though it remains an implicit convention future mappings must preserve.
  • API: No public package APIs, CLI options, or exported symbols change. Both consumers retain the existing task-object input convention, and the documentation-only asset fix does not require a package changelog fragment or deprecation path.
  • Implementation: The external branch correctly preserves paths such as tasks/classic/cartpole.jpg beneath the configured image host, while the local branch preserves non-task mappings beneath ../../_static/. Both changed consumers now use the same resolver, and no broken image-path consumer is evident from the supplied context.

No blocking issues. No inline issue met the actionable-evidence threshold; the assessment above records the review feedback.

Automated review; human maintainers own approval decisions.

@greptile-apps

greptile-apps Bot commented Sep 16, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 4/5

The PR is not safe to merge until local preview URLs preserve the documentation version prefix.

Findings

  1. P1 Local preview drops version ▶

Summary

This PR centralizes environment-preview URL resolution so task images use the external image host while non-task images remain local.

  • The external tasks/... routing is consistent with the generated preview-image values.
  • The local branch traverses one directory too far when documentation is deployed under a version prefix, breaking non-task previews on the hosted site.

Reviews (1) · Last reviewed commit: "Fix environment browser preview image UR..."

const imagePath = previewImageFor(task);
return imagePath.startsWith("tasks/")
? new URL(imagePath, previewImageBaseUrl).href
: new URL(`../../_static/${imagePath}`, window.location.href).href;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 Local preview drops version

On the deployed multi-version site, this page is served from <version>/setup/environments.html. Resolving ../../_static/${imagePath} removes the version segment and requests the image from the site-root _static directory, while static assets are published inside each version directory. Non-task previews such as Lift-Soft-Franka will therefore return 404; resolve the path relative to the current version root instead.

Suggested change
: new URL(`../../_static/${imagePath}`, window.location.href).href;
: new URL(`../_static/${imagePath}`, window.location.href).href;

@kellyguo11

Copy link
Copy Markdown
Contributor

run-ci

@isaaclab-bot isaaclab-bot Bot added ci:run-docker Trigger the on-demand Docker and GPU CI workflow and removed ci:run-docker Trigger the on-demand Docker and GPU CI workflow labels Sep 16, 2026
@kellyguo11
kellyguo11 merged commit adeea93 into isaac-sim:develop Sep 16, 2026
54 checks passed
kellyguo11 added a commit that referenced this pull request Sep 16, 2026
(cherry picked from commit 50ea058)
#7849

# Description

> [!IMPORTANT]
> Confirm the pull request base before submitting. Target `develop` for
all
> contributions. The `release/3.0.0-beta2` branch is a frozen stable
landing
> snapshot and is not used for ongoing maintenance.

<!--
Thank you for your interest in sending a pull request. Please make sure
to check the contribution guidelines.

Link:
https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context.
List any dependencies that are required for this change.

Fixes # (issue)

<!-- As a practice, it is recommended to open an issue to have
discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being
developed or added, and if a given feature
is demanded by more than one party. -->

## Type of change

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (existing functionality will not work without user
modification)
- Documentation update

## Release backport

- [ ] <!-- backport-active-release --> Backport this pull request to the
active release branch after it merges into `develop`

## Screenshots

Please attach before and after screenshots of the change if applicable.

<!--
Example:

| Before | After |
| ------ | ----- |
| _gif/png before_ | _gif/png after_ |

To upload images to a PR -- simply drag and drop an image while in edit
mode and it should upload the image directly. You can then paste that
source into the above before/after sections.
-->

## Checklist

Docker and GPU tests run on demand. Push the commits you want tested,
then
comment `run-ci` on the pull request.

- [ ] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) 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 added a changelog fragment under
`source/<pkg>/changelog.d/` for every touched package (do **not** edit
`CHANGELOG.rst` or bump `extension.toml` — CI handles that)
- [ ] 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
-->

Co-authored-by: Mustafa Haiderbhai <mhaiderbhai@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants