PX4 / PX4-user_guide

PX4 User Guide
https://docs.px4.io/main/en/index.html
Other
282 stars 1.56k forks source link

Update Documentation For New Septentrio-Specific Driver #3253

Closed flyingthingsintothings closed 2 weeks ago

flyingthingsintothings commented 2 weeks ago

As the Septentrio driver has moved from the PX4 GPS drivers repository into the main codebase and received new parameters and features, the documentation needs to be updated to reflect them. I checked the changes with yarn start and everything looks normal. There is one missing link (see bot reply below) which is just a future link that will point to the new parameters once they are available in the documentation, as that will automatically happen from what I understand.

hamishwillee commented 2 weeks ago

Thanks @flyingthingsintothings this is good thanks. I have subedited it for style - in particular for your note:

  1. I break lines on sentences rather than line length. Makes translation easier. Also use prettier for formatting.
  2. I link parameters - makes it easy to check removed components in future. IN general using linking is a "good thing".
github-actions[bot] commented 2 weeks ago

No flaws found

flyingthingsintothings commented 1 week ago

@hamishwillee I didn't find in the contribution guidelines that Prettier was used for formatting. That could maybe be added. Thank you for the edits. I always use max line length but like you say, splitting on sentences does make more sense.

hamishwillee commented 1 week ago

@flyingthingsintothings I guess it is a bit unreasonable for you to guess the requirements :-). Thanks for the timely reminder!

I have made an update in https://github.com/PX4/PX4-user_guide/pull/3261