Documentation#2017
Merged
openminddev merged 7 commits intomainfrom Jan 31, 2026
Merged
Conversation
github-actions
Bot
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation for the Gazebo simulation setup with OM1, streamlining the installation workflow and correcting various documentation issues.
Changes:
- Removed Step 7 (Start OM1) from the Gazebo setup, consolidating the workflow
- Updated dependency installation instructions to use
python3-devinstead of deprecatedpython-all-dev/python-dev - Added virtual environment setup and PYTHONPATH configuration for unitree-sdk
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mintlify/examples/gazebo.mdx | Streamlined Gazebo setup by removing OM1 startup step and renumbering subsequent steps; added venv and PYTHONPATH setup |
| docs/examples/gazebo.mdx | Identical changes to mintlify version for consistency |
| mintlify/developing/6_actions.mdx | Fixed tree structure formatting and added missing orchestrator entry |
| docs/developing/6_actions.mdx | Identical changes to mintlify version for consistency |
| mintlify/developing/1_get-started.mdx | Updated Linux dependency note to specify python3-dev |
| docs/developing/1_get-started.mdx | Identical changes to mintlify version for consistency |
| mintlify/developer_cookbook/introduction.mdx | Capitalized "Input" and added new Action Plugin entry to capabilities list |
| docs/developer_cookbook/introduction.mdx | Capitalized "Input" for consistency |
| config/gazebo_sim.json5 | New configuration file for Gazebo simulation with mode definitions |
| README.md | Updated apt-get command to use python3-dev instead of python-dev |
| .github/ISSUE_TEMPLATE/🌟-bounty.md | Corrected GitHub organization name from OpenmindAGI to Openmind |
Comments suppressed due to low confidence (1)
docs/examples/gazebo.mdx:1
- The hardcoded Python version 3.10 in the path may cause issues if users have a different Python version installed. Consider using a version-agnostic approach or document the Python version requirement.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Export the python path to your virtual environment | ||
|
|
||
| ```bash | ||
| export PYTHONPATH=$PYTHONPATH:$(pwd)/.venv/lib/python3.10/site-packages |
There was a problem hiding this comment.
The hardcoded Python version 3.10 in the path may cause issues if users have a different Python version installed. Consider using a version-agnostic approach or document the Python version requirement.
Suggested change
| export PYTHONPATH=$PYTHONPATH:$(pwd)/.venv/lib/python3.10/site-packages | |
| export PYTHONPATH="$PYTHONPATH:$(python -c 'import site; print(site.getsitepackages()[0])')" |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR modifies gazebo setup and dependency requirements for OM1.
It also adds a new config file to run with Gazebo simulation