Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Let's add a bit of documentation #154

Open
christophfroehlich opened this issue Mar 13, 2023 · 3 comments
Open

Let's add a bit of documentation #154

christophfroehlich opened this issue Mar 13, 2023 · 3 comments

Comments

@christophfroehlich
Copy link
Contributor

  • 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 Example tutorial for Pid #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?

@bmagyar
Copy link
Member

bmagyar commented Mar 14, 2023

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

@christophfroehlich
Copy link
Contributor Author

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
Copy link
Contributor Author

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

Will be added with ros-controls/control.ros.org#278

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants