Guidelines for Editing the Wiki

The wiki is a useful place for documenting ros packages, stacks, and applications. However it is important to keep the wiki organized and up to date. It is hard to maintain the wiki without minimal organization. So here are some general best practices for keeping the wiki well organized.

ROS

• The ROS name space (e.g. "ros.org/wiki/ROS/mynewpage") is special. Do not put documentation in this name space unless you are specifically documenting a part of ROS. Documentation in this name space will be part of the user manual.

ROS and ROS-PKG

• If you need to create new stack or package pages, please use the templates (PackageTemplate and StackTemplate) when you create the page.

• If you need to create reviews for stacks or packages, please use the templates code and API review templates when you create the page.
• Make sure that the package or stack name is the same as in the repository. If your package name is blue_goo then the package documentation should be found at "www.ros.org/wiki/blue_goo".

• If your usage documentation for a package or stack extends past the main page, please put those pages within the namespace of the stack or package (e.g. rviz/DisplayTypes, rviz/UserGuide).

• To create tutorials relevant to your stack that follow the naming conventions, use the "create a tutorial" link at the bottom of the stack page.

• The packages all have menus at the top that list packages associated with the stack. Feel free to edit those at Menus/stack_name, but please try to keep the format consistent.