Skip to content

Fix document according to bug 6198710#5787

Open
sameerchavan0027 wants to merge 1 commit into
isaac-sim:developfrom
sameerchavan0027:sc/doc-update-6198710
Open

Fix document according to bug 6198710#5787
sameerchavan0027 wants to merge 1 commit into
isaac-sim:developfrom
sameerchavan0027:sc/doc-update-6198710

Conversation

@sameerchavan0027
Copy link
Copy Markdown

@sameerchavan0027 sameerchavan0027 commented May 26, 2026

Issue:
play.py verification step fails with FileNotFoundError for office.usd because the COMPASS USD assets (compass_usds.zip) are not listed as a prerequisite in the documentation, causing the script to always fail when run in documented order.
Running play.py (TC-02 — Verify COMPASS Setup) fails with FileNotFoundError for office.usd. The script is hardcoded to load usd/office/office.usd from the mobility_es extension directory, but this file is part of compass_usds.zip (downloaded from nvidia/COMPASS on Hugging Face). The documentation for PR #5599 and the COMPASS navigation guide do not mention downloading and placing the COMPASS USD assets as a prerequisite for running play.py. As a result, play.py will always fail if run before the asset download step.

Solution:
Add the prerequisite (download compass_usdz.zip) steps before running the play.py verification step in the docs

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 May 26, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 26, 2026

Greptile Summary

This PR fixes a documentation sequencing bug where the "Test setup" step was listed before downloading and preparing the COMPASS USD assets that play.py requires, causing the test to fail if followed literally. The section is moved later in both the workflow overview list and the document body, and a prerequisite note is added explaining that the USD assets must be in place first.

  • Workflow overview: Steps 4–7 are reordered so authentication and asset download precede the play.py verification step (now step 7 instead of step 4).
  • Document body: The "Testing the Setup" subsection is relocated from before "Downloading Assets & Checkpoints" to after the NuRec dataset table, with a new sentence clarifying the USD asset placement prerequisite.

Confidence Score: 5/5

Documentation-only change with no code execution path; safe to merge.

The change corrects a logical ordering mistake in the tutorial: the play.py test now appears after the USD assets it depends on are downloaded and placed, and the document body matches. No code is modified, there are no broken RST constructs introduced, and the added prerequisite sentence in the Testing section accurately reflects the dependency.

No files require special attention.

Important Files Changed

Filename Overview
docs/source/policy_deployment/03_compass_with_NuRec/compass_navigation_policy_with_NuRec.rst Reorders workflow steps so 'Test setup' (play.py) comes after asset download/preparation, and moves the corresponding section in the document body with added prerequisite context.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Create workspace] --> B[Install Isaac Sim & Isaac Lab]
    B --> C[Install COMPASS Repository]
    C --> D[Authenticate with Hugging Face]
    D --> E[Download assets\nX-Mobility / COMPASS USDs / NuRec]
    E --> F[Prepare assets\nExtract & place usd/ folder]
    F --> G[Test setup\nplay.py]
    G --> H[Train Residual RL Policy]
    H --> I[Evaluate Trained Policy]
    I --> J[Export to ONNX / TensorRT]
    J --> K[ROS2 / Sim-to-Real Deployment]
Loading

Reviews (1): Last reviewed commit: "Fix document according to bug 6198710" | Re-trigger Greptile

Copy link
Copy Markdown

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

Choose a reason for hiding this comment

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

Documentation Review

Thanks for this documentation improvement!

Summary

This PR reorders the steps in the COMPASS NuRec navigation policy tutorial to fix a logical dependency issue (bug 6198710).

Changes Analysis

What changed:

  • Moved "Test setup" from step 4 to step 7 in the workflow overview
  • Moved the corresponding "Testing the Setup" section to after asset downloading/preparation
  • Added clarification that assets must be in place before testing
  • Renumbered steps: Hugging Face auth is now step 4, download assets is step 5, prepare assets is step 6, test setup is step 7

Why this is correct:
The original documentation instructed users to test the setup before downloading and placing the required assets. The play.py script requires COMPASS USD assets to be present under compass/rl_env/exts/mobility_es/mobility_es/usd/. Running it before assets are in place would fail. This reordering fixes that logical dependency.

CI Status Note

The "Check for Broken Links" CI failure is a pre-existing issue affecting the repository's documentation (redirects in unrelated files like README.md, SECURITY.md, source_installation.rst, etc.). This is not caused by this PR.

Verdict

The documentation change is logically sound and improves the user experience by presenting steps in the correct order. No further changes needed.

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