Clean-up and Unify our Documentation - Githubissues

UTRA-ART / SLAM-1920

SLAM and Navigation on ROS Kinetic

https://utra-art.github.io/SLAM/

3 stars 1 forks source link

Clean-up and Unify our Documentation #66

Closed erickmu1 closed 4 years ago

erickmu1 commented 4 years ago

Description:

Now that Navigation with LIDAR is coming to a close, we need to ensure appropriate documentation exists
Re-organize and complete documentation for all tasks completed with regard to setting up all the ROS packages to enable navigating with LIDAR

Goals:

[x] README should only contain information on how to set up the development environment
[x] Discuss what needs to be documented and how it should be structured so it is easy to navigate
[x] Add more goals (and Acceptance Criterion) based on discussion above ^

Acceptance Criteria:

[x] A new user cloning our repository should be able to get everything working by only following the README
[x] Instructions on how to install all our packages (mandatory and optional packages) exist in some wiki
[x] Wikis explaining how we learned how to use complex packages (eg. creating URDF or Navigation Stack) should exist

Notes:

Feel free to pester anyone to get information/instructions/insight on how they completed a task