PX4 / PX4-user_guide

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

Move FC-quickstarts and update Basic assembly #3228

Closed hamishwillee closed 3 months ago

hamishwillee commented 4 months ago

This moves the quickstarts under their associated flight controller out from the "Basic Assembly" section, and then updated the guide to link to them and also to the build logs. In other words this is now a single page that is all about assembly.

I would like to create a quickstart that is generic, but before I do that my intent is to work out how this Assembly doc can split into the different vehicle sections with single source. Once that's done we are on final stage to pull MC, VTOL, Plane to the top level.

hamishwillee commented 3 months ago

FYI @sfuhrer This is what I've been working on for the last few weeks - still "in progress".

The aim of this is to create vehicle-specific high level assembly guides from a single-ish source. This would replace the FC quickstarts (but link to them), This is the first step. The generic stuff is defined in _assembly.md.

This will be imported into vehicle specific bits - for example, a plane would have its own motors/surfaces section.

Still in progress. I'll create a basic framework that is MC focussed and we can then work on FC and VTOL bits.

After this is in a reasonable shape we should be able to consider splitting out the MC, FW, VTOL sections.

sfuhrer commented 3 months ago

Good stuff, agree with the direction. Please let me know once you need proper reviews.

hamishwillee commented 3 months ago

@sfuhrer Can you please review the _assembly.md doc. This is what will be duplicated for the different vehicles. So this one https://github.com/PX4/PX4-user_guide/blob/42155ad8de344c5c75046dd63a272101545aeb14/en/assembly/_assembly.md

I've still got work to do "around" this, but good to check the core content.

Note, it isn't very specific to a vehicle type, but it does have some customisation.

hamishwillee commented 3 months ago

Thanks for review @sfuhrer

FYI, I have done more work on this today, starting the process of pulling out the MC, VTOL, FW to the top level. I might merge tomorrow. It does highlight that we need a more coherent config guide for VTOL/FW, somewhat like what we "are getting there" for MC.

I think this will be easier with the vehicle sections published - i.e. it will force us to focus on this stuff :-).

Bit more to do with the introduction and operations too to make this all work. Note some things I am still not sure about. For example, here I have MC > Features > Flight modes. I like that, but MC has a lot more features than this. And we don't have any features section for VTOL/FW so things inconsistent. Let's talk :-)

image

github-actions[bot] commented 3 months ago

No flaws found