PX4 / PX4-user_guide

PX4 User Guide

Home Page:https://docs.px4.io/main/en/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[v1.14 Release] Documentation Sync

beniaminopozzan opened this issue · comments

As discussed in today's Maintainers Call some parts of the documentation are out of sync with the PX4 main branch. This issue aims to capture the main points that should be fixed in view of the release of v1.14.0

If anyone is aware of other major points, please add them in the comments.

I ran a tool to find out what params have been removed and added in PX4 v1.14. The params that have been removed and are still in docs imply a docs update. The params that are new are a hint that more docs may be required. Lists are here: https://discord.com/channels/1022170275984457759/1087974671661666314

Can I get dev-team eyes on that list so we can address both cases? @mrpollo I tagged a few members, but if we could get dev team review in a call that would be good.

FYI Another task I have been working on is fixing broken links. These indicate changes that can have either small or larger impact. For example, today a broken link makes it clear that the dropix flight controller by drotek is no longer in production, so I have marked it as discontinued.

Lists are here: https://discord.com/channels/1022170275984457759/1087974671661666314

Just a note for people viewing this issue, this list is constantly being updated in the discord, and we are keeping track of parameters left to document directly in that thread! 🦾

This issue has been mentioned on Discussion Forum for PX4, Pixhawk, QGroundControl, MAVSDK, MAVLink. There might be relevant details there:

https://discuss.px4.io/t/px4-maintainers-call-april-04-2023/31415/1

This issue has been mentioned on Discussion Forum for PX4, Pixhawk, QGroundControl, MAVSDK, MAVLink. There might be relevant details there:

https://discuss.px4.io/t/px4-maintainers-call-april-25-2023/31810/1

Can this finally be closed? #2459

@mrpollo I was going to say "almost"

NAV_TRAFF_A_RADM and NAV_TRAFF_A_RADU were removed in PX4/PX4-Autopilot#21283, but are still in \en\advanced_features\traffic_avoidance_utm.md and the other traffic avoidance docs.

I've asked for some support on this, but no joy. If someone has time, great, otherwise when do you think you'll really be releasing PX4 v1.14. If it is soon I'll do the work to tidy this.

I've asked for some support on this, but no joy.

Sorry I missed this! I have pinged the author of the PR for now, but if we get no reply, I can help out!

when do you think you'll really be releasing PX4 v1.14

From the Community QnA call yesterday we discussed that Release Candidate will come out by next week. However, the actual stable release schedule is uncertain 🤷

Thanks @junwoo091400 No response - did you want to look at this, or should I do it tomorrow?

did you want to look at this, or should I do it tomorrow?

The PR was opend by the author here: #2531

Excellent. I have reviewed. Some fixes required.

All done!