-
Notifications
You must be signed in to change notification settings - Fork 22
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
Add minimal documentation #9
Comments
ROS Wiki states, that: "The ROS Wiki is for ROS 1." There is a "rolling documentation" for ROS2. Probably uploading to the Wiki might not be necessary. What's your opinion? |
I mean the Wiki page on GitHub: https://github.com/kroshu/ros2_kuka_sunrise/wiki |
So the idea is we just write the documentation in our favourite desktop md editor and can track it via git but also make it visible on the Wiki page where navigation is somewhat better |
Okay, misunderstood. Sounds good! :) |
Hey, I pushed an initial documentation to feature/prepare-for-open-collab. I guess it should be enough for now. |
The quick-start seems nice, although the teleop-guided-robot package is missing, I'll add it. |
Done. |
There is currently no public documentation on the usage of the driver. Add minimal documentation describing the architecture, system setup and a quick-start guide.
Proposal: create a doc folder with Markdown files that are then exported to the repository Wiki using the GitHub action wiki-page-creator-action
The text was updated successfully, but these errors were encountered: