Documentation Updates#2550
Conversation
There was a problem hiding this comment.
Pull request overview
Updates product documentation to reflect the new Gazebo simulation repository and revise subscription plan details to include simulator/cloud simulation support.
Changes:
- Update Gazebo simulator setup instructions to point to the
OM1-simrepo and adjust the step flow. - Update API pricing plan bullets (memory wording and simulator instance availability).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
docs/simulators/gazebo.md |
Switches setup instructions from OM1-ros2-sdk to OM1-sim, renumbers steps, and updates notes about premium SLAM/navigation availability. |
docs/api-reference/api_pricing.md |
Updates Builder/Pro plan bullets for memory and adds a simulator instance line to Builder. |
Comments suppressed due to low confidence (1)
docs/simulators/gazebo.md:104
- This page still states it will "generate SLAM map ... and start navigation" (earlier in the doc), but after removing the SLAM/Navigation steps there are no replacement instructions/links in this section. Either update that introductory wording, or add a link/section for SLAM + Navigation setup (especially for Enterprise users).
Step 5: Run Zenoh Ros2 Bridge
To run the Zenoh bridge for the Unitree Go2, you need to have the Zenoh ROS 2 bridge installed. You can find the installation instructions in the [Zenoh ROS 2 Bridge documentation](https://github.com/eclipse-zenoh/zenoh-plugin-ros2dds)
After installing the Zenoh ROS 2 bridge, you can run it with the following command:
| - **Cost:** $99/month | ||
| - **Rate Limit:** 40 requests/second | ||
| - **Memory:** Advanced memory controls (ships June) | ||
| - **Memory:** Unlimited long-term memory and Advanced memory controls (ships June) |
There was a problem hiding this comment.
Capitalization/grammar: "Unlimited long-term memory and Advanced memory controls" capitalizes "Advanced" mid-sentence, unlike the Builder plan bullet. Make capitalization consistent (e.g., "advanced memory controls").
| - **Memory:** Unlimited long-term memory and Advanced memory controls (ships June) | |
| - **Memory:** Unlimited long-term memory and advanced memory controls (ships June) |
| This will bring up the `orchestrator`, to consume data collected by `om1_sensor` for SLAM and Navigation. | ||
|
|
||
| Step 7: Run Zenoh Ros2 Bridge | ||
| Step 5: Run Zenoh Ros2 Bridge |
There was a problem hiding this comment.
Step title uses "Ros2" while the surrounding text/link uses "ROS 2". For consistency (and to match the official naming), update the step heading to use the same capitalization/spacing as the rest of the section.
| Step 5: Run Zenoh Ros2 Bridge | |
| Step 5: Run Zenoh ROS 2 Bridge |
| > **Note**: We don't have auto charging feature supported with Gazebo but it will be launched soon. Stay tuned! | ||
| > **Note**: | ||
| > 1. Auto charging feature is not supported with Gazebo but it will be launched soon. Stay tuned! | ||
| > 2. SLAM Map generation and Navigation are only offered as part of Premium features and would require an active subscription to Enterprise Plan on [OpenMind Portal](https://portal.openmind.com). |
There was a problem hiding this comment.
The note reads awkwardly: "SLAM Map generation and Navigation are only offered as part of Premium features". Consider rephrasing for grammar/clarity (e.g., consistent capitalization and avoiding redundant phrasing like "part of Premium features").
| > 2. SLAM Map generation and Navigation are only offered as part of Premium features and would require an active subscription to Enterprise Plan on [OpenMind Portal](https://portal.openmind.com). | |
| > 2. SLAM map generation and navigation are available only as Premium features and require an active Enterprise Plan subscription on [OpenMind Portal](https://portal.openmind.com). |
| - **Rate Limit:** 20 requests/second | ||
| - **Memory:** Long-term memory (ships March) | ||
| - **Memory:** Advanced session memory controls (ships June) | ||
| - **Simulator Instance:** Dedicated simulator instance(Gazebo and Isaac Sim) (ships April) |
There was a problem hiding this comment.
Formatting: there’s a double space after the colon and a missing space before the parenthetical ("instance(Gazebo..."). Clean up spacing so the bullet renders/readability is consistent with the other plan bullets.
| - **Simulator Instance:** Dedicated simulator instance(Gazebo and Isaac Sim) (ships April) | |
| - **Simulator Instance:** Dedicated simulator instance (Gazebo and Isaac Sim) (ships April) |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Overview
This PR updates the following