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: 1230

Comment by Francisco K on August 27, 2015 at 10:49pm

Agreed, this new website is a huge improvement over the old one. Its not only cleaner, but the navigation throughout the site is very easy. I remember, on the old website, I used to spend quite a bit of time trying to look for something. 


100KM
Comment by Hein du Plessis on August 27, 2015 at 10:50pm
Hear, hear, every time I go back to the wiki I find new pages and more detailed explanations. When I help somebody get into apm I always make sure how lucky they are having this fantastic resource.

Thanks guys
Comment by Kieran on August 27, 2015 at 11:01pm

I second that. As someone who checks the wiki almost daily, I am very grateful for the continuous improvements and additions. Thanks for the great work.


Wiki Ninja
Comment by Hamish Willee on August 28, 2015 at 12:28am

Thanks Chris!

Special thanks to:

  • Individual wiki owners Grant Morphett and Randy Mackay for their constant support, advice, and content improvements. They are the reason why the quality continues to improve.
  • The unsung contributors in our Japanese, Chinese, Korean, Italian and Spanish translation teams.

Developer
Comment by Andrew Tridgell on August 28, 2015 at 3:25am

thanks for your great work Hamish!


Moderator
Comment by Gary Mortimer on August 28, 2015 at 4:44am

I helped a youngster here set up his quad down here last week and used the wiki through out to do it. It did what it said on the tin!

Comment by Cala on August 28, 2015 at 2:12pm

Not only the presentation is much easier to find things, content with lot of photos, graphs, videos and easy clear english helps a lot people like I, that not speak english as native language, great Job, many thank's :)

Comment by Stephen Dade on August 29, 2015 at 2:06am

Thanks for all of your help porting the MAVProxy documentation Hamish!


100KM
Comment by Ben Dellar on August 29, 2015 at 2:28am

Thanks that is looking great.

Can I make a constructive suggestion though, it would be great if each page had a "suggest edit" or "contact author" button or something so that people can provide feedback.

One example is the current MAVProxy documentation doesn't note that some linux systems will need to also have included "python-dev" in their apt-get list for it to run. If you don't have it the error is very obscure and it took me a while to figure out but don't have any option to contact the page author or suggest the edit and save other people a bit of time :)

Comment by Cala on August 29, 2015 at 7:03am

Look's good idea, a quick feedback :)

Comment

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

Join DIY Drones

© 2019   Created by Chris Anderson.   Powered by

Badges  |  Report an Issue  |  Terms of Service