documentation and tutorial review (internal)

ros / rosdistro

This repo maintains a lists of repositories for each ROS distribution

Other

932 stars 2.56k forks source link

documentation and tutorial review (internal) #554

Closed dirk-thomas closed 10 years ago

dirk-thomas commented 11 years ago

Similar to milestone 3 (internal part).

tfoote commented 11 years ago

Steffi's working on a heuristic checklist for tutorials
- Looking at providing a feedback form at the bottom of all Tutorials
- goal is to allow individual maintainers(or anyone) to be able to do the analysis on their Tutorials

jack-oquin commented 11 years ago

I don't know if this counts as "external" or "internal", but I have been thinking about this problem a lot. There are several "topic" pages I'd like to attempt writing:

Where do I declare my dependencies? What do the different kinds of dependencies mean?
How do I install files from my catkin package? What about Python scripts and modules?
How to configure and run unit tests

Should draft versions be done in moinmoin wiki notation or in Sphinx restructuredtext? I personally prefer the latter, but want to do whatever is most useful.

jack-oquin commented 11 years ago

I think we need a task-oriented how-to section to help users leaning catkin.

My current draft is here: http://farnsworth.csres.utexas.edu/docs/catkin/html/howto/index.html

Much work remains to be done. When it looks complete to me, I'll submit a pull ros/catkin request and schedule a doc review for it.

Meanwhile, I appreciate feedback, suggestions and especially corrections.

tfoote commented 11 years ago

Lets scope this to read through: http://www.ros.org/wiki/ROS/Tutorials

wjwwood commented 11 years ago

I will review these: http://www.ros.org/wiki/ROS/Tutorials

wjwwood commented 11 years ago

I will also review these:

http://www.ros.org/wiki/tf/Tutorials

Since I just released geometry_tutorials into hydro.

davetcoleman commented 11 years ago

I've cleaned up much of the wiki home page, Contribute page, and pages linked off of that. One area that needs a lot of work is the Getting Started page including removing all the stack references.

tfoote commented 11 years ago

We've done a lot of this but there's still plenty of work to go. I'm moving the milestone back to the main release.

wjwwood commented 11 years ago

I'll try navigation tutorials too, since I just catkinized it.

tfoote commented 10 years ago

Tutorials and documentation are an ongoing work. This long running ticket does is not helping us track anything. We did get a first pass from @davetcoleman and many have been updated since then.

jack-oquin commented 10 years ago

As long as this remains a background task for people who are already fully engaged in other activities, significant improvements will not be likely.