Repository navigation
Consolidate simulation visualization and interaction docs - #903
Merged
Merged
Conversation
[Low impact] The documentation migration appears safe to merge. SummaryMoves native window controls, Gizmos, and Viser into Simulation Framework → Visualization and Interaction.
Reviews (1) · Last reviewed commit: "docs(sim): consolidate visualization and..." · Reviewed by Greptile |
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.
Description
Unify native window controls, Gizmos, and Viser under Simulation Framework → Visualization and Interaction at
docs/source/overview/sim/visualization/. Update navigation and incoming links, the architecture explorer's curated documentation target, and the sim-visualization context entry.Preserve all published interaction/Viser URLs through the existing redirect mechanism, generalized for documentation pages, and retain the renamed index headings' old anchors. The old asset-preview URL redirects to the existing how-to guide.
Dependencies: none.
Type of change
Validation
black .with Black 26.10.1: 1,760 files unchanged.python docs/scripts/check_api_docs.py: 3,287/3,287 exports documented.make -C docs htmlbuild with the pinned Sphinx 7.4.7 completed successfully. It reports 788 warnings from existing documentation/API content; none are attributed to the four migrated visualization pages.No runtime behavior changes or new test cases were needed; existing focused tests and the generated documentation checks cover the migration. Context review outcome: revise the visualization overview's human-facing documentation entry; implementation guidance and routing remain accurate.
Checklist
black .command to format the code base.