Docs: Overhaul rover documentation #25103
Conversation
chfriedrich98
force-pushed
the
pr-rover_docs_update
branch
from
cd3a76d to
6d8fbd4
Compare
| @@ -0,0 +1,44 @@ | |||
| # Rover Configuration/Tuning | |||
There was a problem hiding this comment.
Do we need to point to other things people might need to do, such as setting up RC controller?
| ```sh | ||
| CONFIG_MODULES_ROVER_ACKERMANN=y | ||
| CONFIG_MODULES_ROVER_DIFFERENTIAL=y | ||
| CONFIG_MODULES_ROVER_MECANUM=y | ||
| ``` |
There was a problem hiding this comment.
Are these independent? I mean if I only want to use ackermann, would I only install that module?
|
Does this need a release note in main? |
hamishwillee
force-pushed
the
pr-rover_docs_update
branch
from
a8e018d to
baf11f7
Compare
|
No flaws found |
| - The module currently supports [manual mode](../flight_modes_rover/differential.md#manual-mode), [acro mode](../flight_modes_rover/differential.md#acro-mode), [stabilized mode](../flight_modes_rover/differential.md#stabilized-mode), [position mode](../flight_modes_rover/differential.md#position-mode) and [auto modes](../flight_modes_rover/differential.md#auto-modes). | ||
| - New module dedicated to [mecanum rovers](../frames_rover/mecanum.md): | ||
| - The module currently supports [manual mode](../flight_modes_rover/mecanum.md#manual-mode), [acro mode](../flight_modes_rover/mecanum.md#acro-mode), [stabilized mode](../flight_modes_rover/mecanum.md#stabilized-mode), [position mode](../flight_modes_rover/mecanum.md#position-mode) and [auto modes](../flight_modes_rover/mecanum.md#auto-modes). | ||
| - New firmware build specifically for [rovers](../config_rover/index.md#flashing-the-rover-build). |
There was a problem hiding this comment.
FYI only, I'm hoping that we are able to manage docs builds properly for v1.16 and that these updates won't leak into that docs build. I'm not all that hopeful.
|
@chfriedrich98 Looks great - not just the docs, but the whole architecture feels more clean. I've subedited, and updated the parameter docs so those broken links are gone. I'm going to merge this, but note the comments - we might need a release note for this. |
Solved Problem
Recent rover development streamlined the different rover modules to a point that their parameters/setpoints are nearly identical.
This PR updates the rover docs to the latest changes and merges the configuration/tuning and flight mode documentation of the different rover modules into a single one.