Repository navigation
Use <name> when documenting API - #64
Merged
Merged
Conversation
…ollow it Signed-off-by: Carlos Agüero <caguero@honurobotics.com> Assisted-by: Claude Fable 5.1 <noreply@anthropic.com>
… docs Signed-off-by: Carlos Agüero <caguero@honurobotics.com> Assisted-by: Claude Fable 5.1 <noreply@anthropic.com>
caguero
changed the title
ahcorde
approved these changes
Sep 16, 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.
Minor documentation update similar to HonuRobotics/holybro_models#16.
The topic tables now read
/<name>/...and each page says what the placeholder is: the instance name,blueboatorbluerov2for the default instance, or whatever the vehicle was spawned as. The namespaces page says the launch argument is the name and that atopic_namespacein a custom config is overridden by it. The three topic paragraphs on the sensors and actuators pages shrink to two sentences each, and<namespace>and<ns>are gone in favour of the one placeholder.