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

[ArduSub Documentation] Full Parameter List · GitBook #253

Open
cbusse1 opened this issue Dec 7, 2022 · 1 comment
Open

[ArduSub Documentation] Full Parameter List · GitBook #253

cbusse1 opened this issue Dec 7, 2022 · 1 comment

Comments

@cbusse1
Copy link

cbusse1 commented Dec 7, 2022

Description

It is unclear from the GitBook whether the documentation is up to date with the latest stable ArduSub Firmware Version (4.1.0), see: https://bluerobotics.com/learn/technical-reference/#software-and-firmware

On GitHub you can find that it is indeed not up to date:
image

Proposal

  • Add the date when the page was last updated and to which ArduSub version it is up to date
  • Competing documentation can be somewhat confusing for the user. Maybe it is advised make a note on each outdated GitBook documentation, and provide reference to the more up to date documentation, e.g. for software version refer to: https://bluerobotics.com/learn/technical-reference/#software-and-firmware

Reference

Bug Page: Full Parameter List · GitBook

@ES-Alexander
Copy link
Contributor

Hi @cbusse1,

In general the documentation in this repo (and currently on ardusub.com) is stale and not being actively updated, while we're transferring to our new docs system. I was hoping to have more of the transfer done by now, but it's ended up more spread out than intended.

Agreed that we should probably put notices on the current outdated pages, and links to the new ones if and when they're available. I've just added a link to the new docs in the technical reference table. For the parameters specifically, I've just recently generated those for 4.1, and they're available at https://docs.bluerobotics.com/ardusub-zola/software/autopilot/ArduSub-4.1/developers/parameters/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants