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

Add minimal documentation #9

Closed
resizoltan opened this issue Mar 27, 2022 · 7 comments · Fixed by #16
Closed

Add minimal documentation #9

resizoltan opened this issue Mar 27, 2022 · 7 comments · Fixed by #16
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@resizoltan
Copy link
Member

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

@resizoltan resizoltan added the documentation Improvements or additions to documentation label Mar 27, 2022
@resizoltan resizoltan self-assigned this Mar 27, 2022
@Groebehavn
Copy link
Member

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?

@resizoltan
Copy link
Member Author

I mean the Wiki page on GitHub: https://github.com/kroshu/ros2_kuka_sunrise/wiki
I think this is a good compromise between having just some markdown files (which is a bit more hassle to navigate for users) and a separate documentation webpage (which is more work for us to set up, but in the future it might be the best way to go - see for example https://control.ros.org/getting_started.html )

@resizoltan
Copy link
Member Author

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

@Groebehavn
Copy link
Member

Okay, misunderstood. Sounds good! :)

@resizoltan
Copy link
Member Author

Hey, I pushed an initial documentation to feature/prepare-for-open-collab. I guess it should be enough for now.
@kovacsge11 it would be nice if you could double-check the quick-start-guide
@Groebehavn if you have time sometime, you could take a look at the ros2_control related section and we could discuss whether you agree

@kovacsge11
Copy link
Contributor

The quick-start seems nice, although the teleop-guided-robot package is missing, I'll add it.

@kovacsge11
Copy link
Contributor

Done.

@resizoltan resizoltan linked a pull request Apr 22, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants