Improvements in APM wikis and other documentation

I'd like to take a moment and call out Hamish Willee and the rest of the documentation team, who every day make scores of improvements to the wikis and other documentation for the APM and other Dronecode project wikis. To give just one example, you may have noticed the new sidebar/menu system, which is clean, clear and works much better on mobile.

On the developer documentation, we're moving to a Sphinx theme, which is easier to maintain and integrates well with the code development process. You can see one such example with the MAVProxy page.

 

If you'd like to be part of the documentation team, you can participate via the maillist, or just post bug or addition requests via the Issue Tracker. They love new contributors! 

Views: 1233


3D Robotics
Comment by Chris Anderson on August 29, 2015 at 7:49am

We could certainly put a link to the Issue Tracker at the bottom of each page. In the past, when we had comments enabled on the page, most of them were just questions that were better handled in the forums here or on the APM Forums, but perhaps if we're clear that the Issue Tracker is for corrections/additions/suggestions that will keep the noise down.


100KM
Comment by Ben Dellar on August 29, 2015 at 8:08am

Ah great - that makes sense. If it is already in the issue tracker as long as it is clear somewhere to go there for input that would be good (I'll pop this one in now)

Can understand that you don't want the wiki turning into another help forum for sure.

Comment by Cala on August 29, 2015 at 8:20am

Ah!, yes, I remember that Chris, I agree your idea.


Wiki Ninja
Comment by Hamish Willee on September 1, 2015 at 7:32pm

FYI all - we have added a link to the issue tracker at the bottom of the wiki docs - you can find out a bit more information here: https://github.com/diydrones/ardupilot-wiki-issue-tracker/issues/139

I'll add a separate issue for the MAVProxy docs.

Thanks for the suggestion


100KM
Comment by Ben Dellar on September 1, 2015 at 9:21pm

That sounds great - 100% agree with this approach.

Comment

You need to be a member of DIY Drones to add comments!

Join DIY Drones

Groups

Season Two of the Trust Time Trial (T3) Contest 
A list of all T3 contests is here. The current round, the Vertical Horizontal one, is here

© 2020   Created by Chris Anderson.   Powered by

Badges  |  Report an Issue  |  Terms of Service