Improve docs#1835
Conversation
github-actions
Bot
added
the
documentation
There was a problem hiding this comment.
Pull request overview
This PR updates the CycloneDDS setup documentation to include network interface configuration and reorganizes installation steps for better clarity. It also fixes a file extension reference and removes an outdated dependency.
Changes:
- Enhanced CycloneDDS configuration with network interface setup and separated XML config from bashrc exports
- Fixed file extension reference from
.jsonto.json5in installation guide - Removed
python3-devdependency from Linux installation instructions
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| mintlify/examples/gazebo.mdx | Reorganized CycloneDDS setup, added CYCLONEDDS_INTERFACE configuration, and included Python CycloneDDS module installation |
| mintlify/developing/1_get-started.mdx | Fixed config file extension reference and removed code block language specifier |
| docs/examples/gazebo.mdx | Mirror of changes to mintlify/examples/gazebo.mdx |
| docs/developing/1_get-started.mdx | Removed python3-dev from Linux installation command |
Comments suppressed due to low confidence (2)
docs/examples/gazebo.mdx:1
- The hardcoded paths
/home/openmind/Documents/GitHub/cyclonedds/assume a specific directory structure that may not match all users' environments. Consider documenting that users should replace these paths with their actual cyclonedds installation location.
docs/examples/gazebo.mdx:1 - The command uses
--extra ddsbut the correct uv flag for installing extras is--extra=dds(with an equals sign) or using bracket notation in the package specification.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| git clone https://github.com/eclipse-cyclonedds/cyclonedds -b releases/0.10.x | ||
| cd cyclonedds && mkdir build install && cd build | ||
| cmake -DBUILD_EXAMPLES=ON -DCMAKE_INSTALL_PREFIX=$HOME/Documents/GitHub/cyclonedds/install .. |
There was a problem hiding this comment.
The hardcoded path $HOME/Documents/GitHub/cyclonedds/install assumes a specific directory structure that may not exist for all users. Consider using a more generic path like $HOME/cyclonedds/install or using the current directory's parent with a relative path.
| cmake -DBUILD_EXAMPLES=ON -DCMAKE_INSTALL_PREFIX=$HOME/Documents/GitHub/cyclonedds/install .. | |
| cmake -DBUILD_EXAMPLES=ON -DCMAKE_INSTALL_PREFIX=$HOME/cyclonedds/install .. |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (2)
docs/examples/gazebo.mdx:1
- The hardcoded path
$HOME/Documents/GitHub/cyclonedds/installassumes a specific directory structure that may not exist for all users. Consider using a more generic path like../installor instructing users to replace this with their preferred installation directory.
docs/examples/gazebo.mdx:1 - These instructions (lines 113-122) duplicate the earlier bashrc configuration steps (lines 95-106). This duplication may confuse users about which section to follow.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| source ~/.bashrc | ||
| ``` | ||
|
|
||
| To add the config to your bashrc, run: |
There was a problem hiding this comment.
These instructions (lines 113-122) duplicate the earlier bashrc configuration steps (lines 95-106). This duplication may confuse users about which section to follow.
Overview
This PR updates cyclonedds setup steps, include network interface, and updates minor setup steps for gazebo