ros-controls / ros-controls/control_toolbox
Let's add a bit of documentation
Open
Nobody has claimed this yet.
persistent
stale
- Dominant language
- C++
- Stars
- 176
- Forks
- 124
- Avg merge
- 3h 44m
- Merged PRs (30d)
- 9
Description
- 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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Check the first line of the README on the ros2-master branch and compare it with the intended ROS 2 documentation. Review the demos proposed in issue #70 and the existing tests that demonstrate function usage. Done means the README links to the correct docs and user-facing demos or examples are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100