Skip to content

Consolidate simulation visualization and interaction docs - #903

Merged
yuecideng merged 1 commit into
mainfrom
codex/docs-visualization-interaction
Oct 29, 2026
Merged

yuecideng merged 1 commit into
mainfrom
codex/docs-visualization-interaction

Conversation

@yuecideng

Copy link
Copy Markdown
Contributor

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

  • Documentation update

Validation

  • black . with Black 26.10.1: 1,760 files unchanged.
  • python docs/scripts/check_api_docs.py: 3,287/3,287 exports documented.
  • Context map validation and 42 existing context tests passed.
  • 33 existing documentation tooling tests passed.
  • Full make -C docs html build 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.
  • Generated HTML checks passed for all 20 redirects (15 existing robot redirects and 5 migration redirects), including 60 JavaScript cases preserving query strings/fragments, migrated navigation, legacy heading anchors, and architecture links.

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

  • I have run the black . command to format the code base.
  • I reviewed affected documentation and agent context and updated their navigation targets.
  • Public API documentation coverage passes; no public API changes.
  • I verified appropriate coverage and reviewed test necessity.
  • Dependencies are unchanged.

@yuecideng yuecideng added docs Documentation, API references and example explanations. visualization Browser viewers, markers, trajectory previews and interactive debugging displays. labels Oct 29, 2026
@greptile-apps

greptile-apps Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The documentation migration appears safe to merge.

Summary

Moves native window controls, Gizmos, and Viser into Simulation Framework → Visualization and Interaction.

  • Simulation visualization and interaction guides now sit together in one section.
  • Old visualization and interaction page addresses now lead to their new destinations.

Reviews (1) · Last reviewed commit: "docs(sim): consolidate visualization and..." · Reviewed by Greptile

@yuecideng
yuecideng merged commit 2d73658 into main Oct 29, 2026
6 of 8 checks passed
@yuecideng
yuecideng deleted the codex/docs-visualization-interaction branch October 29, 2026 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation, API references and example explanations. visualization Browser viewers, markers, trajectory previews and interactive debugging displays.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant