docs: update transforms 3D-viz instructions for rerun#2156
Conversation
Greptile SummaryReplaces the stale Foxglove-Studio 3D-visualization instructions (and their inline TODO) in
Confidence Score: 5/5Documentation-only change with no code modifications; safe to merge. The change removes a stale TODO and Foxglove paragraph, replacing it with a verified Rerun workflow. The entity path (world/tf/<child_frame_id>) and the blueprint's Spatial3DView origin (world) both match the live source code, and dimos rerun-bridge is a registered CLI entry point in pyproject.toml. There is nothing to break. No files require special attention. Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant Terminal1 as Terminal 1
participant Terminal2 as Terminal 2
participant RerunBridge as dimos rerun-bridge
participant RerunViewer as Rerun Viewer
participant Example as Multi-Module Example
participant LCM as LCM Bus
User->>Terminal1: dimos rerun-bridge
Terminal1->>RerunBridge: start bridge
RerunBridge->>RerunViewer: open viewer (Spatial3DView rooted at world)
RerunBridge->>LCM: subscribe to TF topic
User->>Terminal2: run multi-module example
Terminal2->>Example: execute
Example->>LCM: self.tf.publish() → TFMessage
LCM->>RerunBridge: deliver TFMessage
RerunBridge->>RerunViewer: "log world/tf/<child_frame_id> entities"
RerunViewer-->>User: renders transform tree in 3D
Reviews (1): Last reviewed commit: "docs: update transforms 3D-viz instructi..." | Re-trigger Greptile |
leshy
left a comment
There was a problem hiding this comment.
hi, did you actually test this? would be nice to add screenshot
|
Closing — this was overtaken by #2122 (DIM-877), which removed Foxglove support entirely and replaced this same paragraph with a link to |
Problem
docs/usage/transforms.mdcarried an inline(TODO we need to update this for rerun). The 3D-visualization instructions still told readers to usefoxglove-studio-bridge/foxglove-studio, but Rerun is now the default viewer backend. No tracked issue — this resolves the in-doc TODO directly.Solution
Replaced the Foxglove instructions with the direct Rerun equivalent,
dimos rerun-bridge. This works end-to-end with no other changes:TFMessage.to_rerun()maps each transform to theworld/tf/<child_frame_id>entity path, and the default Rerun blueprint roots itsSpatial3DViewatworld, so the example's transform tree renders automatically. Added a note to start the bridge before the example (it runs briefly; TF buffer is short-lived). Scoped to the TODO line; the existing screenshot asset is left untouched.How to Test
In one terminal:
dimos rerun-bridge; then run the multi-module example from the doc — theworld/tf/*frames render in the Rerun 3D view.Contributor License Agreement