Uh oh!
There was an error while loading. Please reload this page.
Reorganize interactive simulation documentation - #508
Merged
Conversation
Document Viser as a canonical interaction frontend and add a Gizmo feature guide. Move asset preview into the task-oriented guides section while retaining the old URL as a migration stub.
Greptile SummaryReorganizes interactive-simulation documentation around native and Viser frontends, shared Gizmo controls, and task-oriented workflows.
Confidence Score: 5/5The documentation-only reorganization appears safe to merge, with no concrete broken links, incorrect workflows, or repository-rule violations identified. The new navigation targets and labels resolve, the moved page retains an old-path migration stub, the literal-include marker exists, and the documented CLI and Gizmo workflows align with their implementations.
|
| Filename | Overview |
|---|---|
| docs/source/features/interaction/index.rst | Reframes interactive simulation around frontends, controls, and related workflows with resolving navigation targets. |
| docs/source/features/interaction/gizmo.md | Adds an accurate feature-level guide for Gizmo targets, lifecycle, update loops, and Viser trust boundaries. |
| docs/source/guides/preview_asset.md | Adds a comprehensive task-oriented asset-preview guide consistent with the current CLI and object pose APIs. |
| docs/source/features/interaction/preview_asset.md | Replaces the former guide with an orphan migration page preserving the old documentation path. |
| docs/source/overview/sim/viser_visualization.md | Removes duplicated preview details and links to the dedicated Gizmo and asset-preview documentation. |
| docs/source/tutorial/gizmo.rst | Connects the tutorial to the feature guide and updates its literal-include marker to match the current script. |
Reviews (1): Last reviewed commit: "docs(interaction): reorganize interactio..." | Re-trigger Greptile
Uh oh!
There was an error while loading. Please reload this page.
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Reorganizes the interactive simulation documentation around frontends,
cross-frontend controls, and task-specific workflows.
native DexSim window.
trajectory replay from the landing page.
the old URL as a migration stub.
without duplicating their dedicated documentation.
No issue is linked. No dependencies are required or changed.
Type of change
Screenshots
Not applicable; this PR changes documentation structure, navigation, and prose.
Validation
black --check --diff --color ./(656 files unchanged)python -m sphinx -q -b html -w <warnings.log> docs/source <html>(exit 0; no warnings attributable to the new or reorganized pages)
python -m embodichain preview-asset --helppython -m pytest tests/visualization/test_example_tutorial_coverage.py -q(1 passed)
git diff --checkThe full Python test suite was not run because this is a documentation-only
change. The Sphinx build retains unrelated repository baseline warnings; the
warning on
simready_pipeline.md:26also exists onmain.Checklist