Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC]: Instructions on how to get started are confusing and not comprehensive #51

Closed
evan-palmer opened this issue Jul 20, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation high priority This is a high priority issue

Comments

@evan-palmer
Copy link
Collaborator

Documentation Change Type

Adding new documentation to the BlueROV2 driver documentation

Documentation Location

The project README

Documentation Problem

Per #45 the current startup instructions recommend that users start with the following command:

ros2 launch blue_bringup bluerov2_heavy.launch.py

The issue with this is that the command does not launch anything (it is not designed to) and simply shows an error message when ArduPilot fails to establish a connection with MAVROS (if the user does not have an active connection to a vehicle).

Suggested Change

The full documentation needs an update sigh, but one way to start out would be to update the README to describe how to launch the simulation environment:

ros2 launch blue_bringup bluerov2_heavy.launch.py use_sim:=true

Once #50 has been resolved, the original command could be preserved with RViz2 automatically starting. Nonetheless, when a user starts the system for the first time, they should see something (other than an error) happen.

@evan-palmer evan-palmer added documentation Improvements or additions to documentation high priority This is a high priority issue labels Jul 20, 2023
@evan-palmer evan-palmer added needs triage This issue needs triage support and removed high priority This is a high priority issue labels Aug 21, 2023
@evan-palmer evan-palmer self-assigned this Oct 25, 2023
@evan-palmer evan-palmer added high priority This is a high priority issue and removed needs triage This issue needs triage support labels Oct 25, 2023
@evan-palmer
Copy link
Collaborator Author

Duplicate of #31

@evan-palmer evan-palmer marked this as a duplicate of #31 Apr 1, 2024
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 high priority This is a high priority issue
Projects
None yet
Development

No branches or pull requests

1 participant