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

ROS documentation #38

Open
rland93 opened this issue Apr 26, 2022 · 0 comments
Open

ROS documentation #38

rland93 opened this issue Apr 26, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed ROS

Comments

@rland93
Copy link
Member

rland93 commented Apr 26, 2022

I want to put some more documentation about ROS development into our documentation page.

Right now, documentation for the project is tied to main because of auto-generation of the python package documentation.

But, we will need also to document setup, installation, dependencies, and so on, of the ROS side of things.

Ultimately, I want to create an "intro to ROS" section of our documentation, that will point a new user to all of the resources they need to get a ROS environment working, install ROS/catkin/, build a workspace, etc.

I'm not going to write tutorials for all that but most people will have a hard time finding this information.

So it's a little awkward, but basically you need to have checked out main (which won't have any of the ROS code in it) to write documentation. I think this is an OK compromise, since most ROS developers will have cloned this repo into both catkin_ws and somewhere else on their PC to develop on main and ROS simultaneously.

@rland93 rland93 added documentation Improvements or additions to documentation ROS help wanted Extra attention is needed labels Apr 26, 2022
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 help wanted Extra attention is needed ROS
Projects
None yet
Development

No branches or pull requests

1 participant