Restructure the X500 documentation into per vehicle sections - #10
Merged
Merged
Conversation
…t used by bluerobotics_models Assisted-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Carlos Agüero <caguero@honurobotics.com>
…ation pages matching bluerobotics_models Assisted-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Carlos Agüero <caguero@honurobotics.com>
ahcorde
approved these changes
Aug 31, 2026
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
2 participants
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
Restructures the X500 documentation to the per vehicle section layout used by bluerobotics_models: the single page becomes a section with Running the simulation, Actuators, Sensors and Configuration. Each API page opens with a plain availability table and documents the topics in per component tables (ROS Topic, Description, linked Message type); the actuators page states why the rotors have no ROS API and shows the Gazebo motor bus, with a manual spin example. Cross links updated.
How to test it?
The docs check on this PR renders the site; open the X500 section and walk Running, Actuators, Sensors and Configuration. Locally:
python -m sphinx -W -b html docs /tmp/holybro_html(needs sphinx with the honu theme) and browse/tmp/holybro_html/vehicles/x500/.