Fix/docs #734
Open
Fix/docs #734
Conversation
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
jaagut
commented
Jan 22, 2026
| "-w", | ||
| "--workspace", | ||
| default=".", | ||
| default="/home/bitbots/bitbots_main", |
Member
Author
There was a problem hiding this comment.
Where do we want to put the bitbots_main dir on the robot?
Member
There was a problem hiding this comment.
I would expect bitbots_main to live in the home dir
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request updates and simplifies the Bit-Bots public documentation, focusing on installation instructions, deployment processes, and general documentation improvements.
Changes:
- Updated installation guide to reflect current pixi-based workflow and removed outdated ROS2-specific instructions
- Reorganized robot deployment documentation, moving Ansible configuration section before deployment steps
- Corrected spelling errors and improved formatting consistency across multiple documentation files
- Removed obsolete style guide XML files for Python and C++ as the project now uses pre-commit hooks
- Updated script documentation and fixed variable naming inconsistencies (e.g., meta_dir → main_dir)
Reviewed changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| src/bitbots_misc/bitbots_docs/package.xml | Cleaned up XML formatting and removed obsolete documentation metadata |
| src/bitbots_misc/bitbots_docs/docs/manual/tutorials/webots_simulation_testing.rst | Simplified setup instructions and removed redundant SSH key setup steps |
| src/bitbots_misc/bitbots_docs/docs/manual/tutorials/vscode-ros2.rst | Updated to reflect pixi environment instead of ROS sourcing |
| src/bitbots_misc/bitbots_docs/docs/manual/tutorials/lowlevel.rst | Removed GitHub repository link and cleaned up whitespace |
| src/bitbots_misc/bitbots_docs/docs/manual/tutorials/installation.rst | Updated guide title, fixed prerequisites spelling, improved formatting, and updated Ubuntu version references |
| src/bitbots_misc/bitbots_docs/docs/manual/tutorials/configure_and_flash_robot.rst | Reorganized sections, moved Ansible configuration before deployment, updated terminology from "Flash" to "Deploy" |
| src/bitbots_misc/bitbots_docs/docs/manual/tutorials/competition_wifi.rst | Updated ansible repository URL from git.mafiasi.de to GitHub |
| src/bitbots_misc/bitbots_docs/docs/manual/testing/testing.rst | Fixed section header underlines for proper reStructuredText formatting |
| src/bitbots_misc/bitbots_docs/docs/manual/testing/test_robot_hardware.rst | Updated deployment terminology and improved wording |
| src/bitbots_misc/bitbots_docs/docs/manual/testing/test_motion.rst | Fixed spelling of "Alternatively" |
| src/bitbots_misc/bitbots_docs/docs/manual/testing/competition_preparation.rst | Updated "NUC" references to generic "PC" |
| src/bitbots_misc/bitbots_docs/docs/manual/software/coding_style.rst | Replaced detailed style guides with pre-commit hook documentation |
| src/bitbots_misc/bitbots_docs/docs/manual/hardware/mechanics/screws.rst | Added warning note about outdated content |
| src/bitbots_misc/bitbots_docs/docs/index.rst | Updated main page description and corrected Github→GitHub |
| src/bitbots_misc/bitbots_docs/docs/_static/bitbots_python_style.xml | Removed obsolete Python style configuration file |
| src/bitbots_misc/bitbots_docs/docs/_static/bitbots_cpp_style.xml | Removed obsolete C++ style configuration file |
| src/bitbots_misc/bitbots_docs/cmake/enable_bitbots_docs.cmake.in | Fixed spelling of "necessary" and updated comment about catkin→package |
| src/bitbots_misc/bitbots_docs/CMakeLists.txt | Updated comment removing catkin reference |
| scripts/setup.sh | Renamed variables from meta_dir to main_dir, added HTTPS fallback for git clone, improved basler camera handling |
| scripts/make_basler.sh | Added Ubuntu version check to ensure compatibility with Pylon driver package |
| scripts/deploy/deploy_robots.py | Changed default workspace path to absolute path |
| scripts/README.md | Updated task numbering and descriptions |
| README.md | Simplified installation instructions with reference to documentation |
Comments suppressed due to low confidence (2)
src/bitbots_misc/bitbots_docs/docs/manual/tutorials/installation.rst:9
- Corrected spelling of 'Prerequisites' from 'Prerequirements'.
src/bitbots_misc/bitbots_docs/docs/manual/tutorials/installation.rst:43 - The URL protocol should be HTTPS instead of HTTP for security. Changed from 'http://doku.bit-bots.de' to 'https://doku.bit-bots.de'.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/bitbots_misc/bitbots_docs/docs/manual/tutorials/configure_and_flash_robot.rst
Outdated
Show resolved
Hide resolved
src/bitbots_misc/bitbots_docs/docs/manual/tutorials/lowlevel.rst
Outdated
Show resolved
Hide resolved
…and_flash_robot.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Flova
reviewed
Jan 28, 2026
| git clone "$REPO_URL" | ||
| echo "Cloning repository bitbots_main..." | ||
| # Try to clone via SSH first, fall back to HTTPS if that fails | ||
| if ! git clone "$REPO_URL_SSH"; then |
Member
There was a problem hiding this comment.
I am not sure if I like this implicit fallback. It might cause problems later on if people try to push via ssh.
Member
Author
There was a problem hiding this comment.
I am also not 100% happy with that.
Who is the target user of this script?
- Obviously, we want our members to use this script and we can throw and error message explaining how to setup the SSH key on GitHub and try again, then exit.
- But in general, these kind of scripts are targeted at the general external community, which we also want to support. These people might only "consume" software and do not intend to ever contribute. They might not even have a GitHub account, and demanding them to create an account and upload some weird S s H (?) key just to continue this crashing one-script-to-setup-everything is too much.
Compromise: If SSH clone fails, warn about missing keys and link to guide how to set them up. Then ask user, if they intend to fix this or continue with HTTPS.
src/bitbots_misc/bitbots_docs/docs/manual/tutorials/configure_and_flash_robot.rst
Show resolved
Hide resolved
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.
Summary
This updates several sections of our public documentation and simplifies the installation instructions a bit.
Proposed changes
Related issues
Checklist
colcon build