Add a current URDF loading guide to the Habitat-Sim docs - #2644
Closed
yurekami wants to merge 1 commit into
Closed
Conversation
Issue facebookresearch#1919 is still open because URDF import works in code but not as a discoverable user-facing guide. This adds one focused docs page tied to the current viewer and physics tests, then wires it into the published docs navigation so users can find the maintained entry points without digging through source files. Constraint: Full docs build in CI depends on a Bullet-enabled habitat_sim install that is not present in this workspace Rejected: Add a brand new tutorial script | broader diff than needed to close the documentation gap Rejected: Update only attributesJSON | still leaves the direct runtime loading path hard to discover Confidence: high Scope-risk: narrow Directive: Keep this page aligned with tests/test_physics.py and examples/viewer.py when URDF loading APIs or viewer shortcuts change Tested: git diff --check; repo-local structural validation of docs wiring and referenced assets
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why
Issue #1919 remains open because URDF import is supported in code, but the maintained docs do not provide a straightforward guide for loading a URDF in current Habitat-Sim.
Verification
git diff --checkexamples/viewer.pyandtests/test_physics.pyA full docs build requires the Bullet-enabled Habitat-Sim install used by repository CI.
Closes #1919