Skip to content

Documentation Updates#2550

Merged
openminddev merged 2 commits into
mainfrom
sim-docs
Apr 27, 2026
Merged

Documentation Updates#2550
openminddev merged 2 commits into
mainfrom
sim-docs

Conversation

@Prachi1615
Copy link
Copy Markdown
Collaborator

Overview

This PR updates the following

  • Documentation for Gazebo with the new repo
  • API pricing to include cloud simulation support from builder plan and above

Copilot AI review requested due to automatic review settings April 27, 2026 23:14
@Prachi1615 Prachi1615 requested review from a team as code owners April 27, 2026 23:14
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 27, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-sim repo 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)
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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").

Suggested change
- **Memory:** Unlimited long-term memory and Advanced memory controls (ships June)
- **Memory:** Unlimited long-term memory and advanced memory controls (ships June)

Copilot uses AI. Check for mistakes.
Comment thread docs/simulators/gazebo.md
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
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
Step 5: Run Zenoh Ros2 Bridge
Step 5: Run Zenoh ROS 2 Bridge

Copilot uses AI. Check for mistakes.
Comment thread docs/simulators/gazebo.md
> **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).
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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").

Suggested change
> 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).

Copilot uses AI. Check for mistakes.
- **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)
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- **Simulator Instance:** Dedicated simulator instance(Gazebo and Isaac Sim) (ships April)
- **Simulator Instance:** Dedicated simulator instance (Gazebo and Isaac Sim) (ships April)

Copilot uses AI. Check for mistakes.
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@openminddev openminddev merged commit c3ef7a5 into main Apr 27, 2026
12 checks passed
@openminddev openminddev deleted the sim-docs branch April 27, 2026 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants