mavlink
ROS2: Documentation book
Ros wiki is outdated and not really helpful for a new people to find info. Need to make something to generate plugin documentation.
I agree — the ROS Wiki is definitely outdated and hard to navigate for new users. How can we help with generating the plugin documentation?
the MAVROS documentation could definitely benefit from a more structured, Ardupilot-style approach. It shouldn’t just list topics and services, but also include sections like installation, getting started, configuration, and example demos. That way, users can better understand how to set things up correctly instead of running into common issues like “this topic isn’t publishing.” A well-organized doc would make onboarding and troubleshooting much smoother.
While i agree that examples should be there, i do not have one. So at minimum i want to have ROS API documented, that already be very handy.
I can work on the examples. I have few examples which I made for my self. Can be useful for the other users aswell.
I'm considering whether it would be appropriate to open a pull request to contribute MAVROS-related examples, specifically focusing on services and topics. There are two potential approaches: one is to start with an initial set of essential examples by creating a mavros_examples package and then encourage community contributions by opening “good first issues” for additional examples. The other is to wait until a complete and comprehensive set of examples is ready before merging. The purpose of the examples would be to address common pain points—particularly misunderstandings around how specific MAVROS topics and services behave or are expected to function. These examples would serve as clear reference implementations to help users avoid frequent mistakes. I’d appreciate feedback on which direction would be more suitable for the project, and I’m happy to proceed with either.
I think mavros_examples would be good, similar to turtlebot or other study bots, where you can run some common examples.
I wanted to confirm the right structure for documentation.
Should we create a mavros_examples package that includes example nodes along with a README describing each example?
And in the mavros/docs folder, should we add separate .md files where all the topics and services are described in detail, with a short introduction for each?
I think better to to describe each example on docs/examples/ so they will be available here https://mavros.readthedocs.io/en/latest/
Package itself must have minimal readme, just describing what's that package is about.