search

space-ros / docs

The Space ROS documentation site.
Creative Commons Attribution 4.0 International
8 stars 11 forks source link

NASA Challenge_[@damianphim]_[Update Documentation] (closes #34) #37

Open damianphim opened 2 months ago

damianphim commented 2 months ago

Closes #34

Demo and First-Time Building Overhaul

Previously, there was no documentation for any of the demos and the Space ROS documentation was outdated, so it took me like 3 days (embarrassing I know) to just build and get the demos running without any errors.

This PR updates the First-Time Building Space ROS page in the documentation (Tutorials -> First-Time Building Space ROS) to the latest method. In addition, it adds documentation for building and running MoveIt2, the Canadarm Demo, and the Curiosity Mars Rover demo.

I'm hoping this PR helps any future contributors not run into the same wall that I did!

130s commented 2 months ago

it took me like 3 days (embarrassing I know) to just build and get the demos running without any errors.

Not just you, I spent a day and haven't been able to see Mars rover on a simulator yet :/

I see this PR is updating .rst files. I asked why space_ros uses rst https://github.com/space-ros/space-ros/discussions/210 (I'm not against it, it just raises hurdle IMO).

damianphim commented 2 months ago

Not just you, I spent a day and haven't been able to see Mars rover on a simulator yet :/

Sounds like you made more progress than me on my first day, don't give up!

I see this PR is updating .rst files. I asked why space_ros uses rst space-ros/space-ros#210 (I'm not against it, it just raises hurdle IMO).

I believe the ROS 2 documentation also uses .rst files, which could be it.