control_toolbox icon indicating copy to clipboard operation
control_toolbox copied to clipboard

Published 20 hours ago • verified publisher icon ros-controls

Let's add a bit of documentation

Open christophfroehlich opened this issue 2 years ago • 4 comments

  • The very first line in the readme of the ros2-master branch points to non-ROS 2 docs
  • Maybe add/link some demos as proposed in #70. I know that one can use the tests to figure out how to use the functions, but that's not very userfriendly imho ;)

What do you think?

christophfroehlich avatar Mar 13 '23 08:03 christophfroehlich

Absolutely! I wonder if we could also hook control_toolbox into the control.ros.org doxygen generation

bmagyar avatar Mar 14 '23 18:03 bmagyar

Yeah, why not. But maybe it's more important to have some high-level human-readable docs on control.ros.org than the API. The latter one is not that easy to find, and I never found something relevant via google but only ROS 1-related on http://docs.ros.org. Probably we should cross-link https://control.ros.org/master/doc/api/ more often.

christophfroehlich avatar Mar 14 '23 19:03 christophfroehlich

Absolutely! I wonder if we could also hook control_toolbox into the control.ros.org doxygen generation

Will be added with https://github.com/ros-controls/control.ros.org/pull/278

christophfroehlich avatar Apr 20 '24 19:04 christophfroehlich