From c7cecbf7f2bdddfcb3b1ac4923c459f4b2ce9f1b Mon Sep 17 00:00:00 2001 From: yuecideng Date: Thu, 29 Oct 2026 14:57:25 +0000 Subject: [PATCH] docs(sim): consolidate visualization and interaction guides --- .../sim-visualization/sim-visualization.md | 2 +- docs/architecture/curated.json | 2 +- ...{robot_redirect.html => doc_redirect.html} | 6 +++--- docs/source/conf.py | 13 +++++++++---- .../features/interaction/preview_asset.md | 8 -------- docs/source/guides/cli.md | 2 +- docs/source/guides/configuration.md | 4 ++-- docs/source/guides/preview_asset.md | 2 +- docs/source/guides/run_task.md | 2 +- docs/source/index.rst | 1 - docs/source/overview/sim/index.rst | 6 +++--- docs/source/overview/sim/sim_manager.md | 8 ++++---- .../sim/visualization}/gizmo.md | 2 +- .../sim/visualization}/index.rst | 19 ++++++++++++------- .../viser.md} | 8 ++++---- .../sim/visualization}/window.md | 4 ++-- docs/source/quick_start/install.md | 4 ++-- docs/source/tutorial/create_cloth.rst | 2 +- docs/source/tutorial/create_scene.rst | 4 ++-- docs/source/tutorial/create_softbody.rst | 2 +- docs/source/tutorial/gizmo.rst | 2 +- docs/source/tutorial/rigid_object_group.rst | 2 +- docs/source/tutorial/sensor.rst | 2 +- 23 files changed, 54 insertions(+), 53 deletions(-) rename docs/source/_templates/{robot_redirect.html => doc_redirect.html} (78%) delete mode 100644 docs/source/features/interaction/preview_asset.md rename docs/source/{features/interaction => overview/sim/visualization}/gizmo.md (98%) rename docs/source/{features/interaction => overview/sim/visualization}/index.rst (78%) rename docs/source/overview/sim/{viser_visualization.md => visualization/viser.md} (99%) rename docs/source/{features/interaction => overview/sim/visualization}/window.md (98%) diff --git a/agent_context/topics/sim-visualization/sim-visualization.md b/agent_context/topics/sim-visualization/sim-visualization.md index 17ef800b2..181d834a9 100644 --- a/agent_context/topics/sim-visualization/sim-visualization.md +++ b/agent_context/topics/sim-visualization/sim-visualization.md @@ -25,7 +25,7 @@ | `embodichain/lab/scripts/_preview.py`, `preview_joint_control.py` | Shared preview stepping, frontend setup, and simulation-thread joint controls | Human-facing behavior and usage are documented in -`docs/source/overview/sim/viser_visualization.md`. +`docs/source/overview/sim/visualization/index.rst`. ## Ownership and Data Flow diff --git a/docs/architecture/curated.json b/docs/architecture/curated.json index 6a66ff16b..96d08e2d5 100644 --- a/docs/architecture/curated.json +++ b/docs/architecture/curated.json @@ -818,7 +818,7 @@ ], "documentation": [ { - "docname": "overview/sim/viser_visualization", + "docname": "overview/sim/visualization/viser", "label": "Browser visualization guide" } ], diff --git a/docs/source/_templates/robot_redirect.html b/docs/source/_templates/doc_redirect.html similarity index 78% rename from docs/source/_templates/robot_redirect.html rename to docs/source/_templates/doc_redirect.html index 0ace13e92..4dd785f6e 100644 --- a/docs/source/_templates/robot_redirect.html +++ b/docs/source/_templates/doc_redirect.html @@ -1,9 +1,9 @@ -{% set target = pathto(robot_doc_redirects[pagename]) %} +{% set target = pathto(doc_redirects[pagename]) %} - Robot documentation moved + Documentation moved