Read the Docs documentation + tutorials

b-it-bots / mas_domestic_robotics

Robot-independent ROS packages for domestic applications

GNU General Public License v3.0

28 stars 45 forks source link

Read the Docs documentation + tutorials #258

Closed alex-mitrevski closed 1 year ago

alex-mitrevski commented 2 years ago

This PR adds:

documentation of the architecture
documentation of implemented actions and behaviours
various tutorials for using the implemented functionalities and working with our robot

Note: The documentation is not complete, but I'll merge this so that the docs page can be set up; content can be added later.

minhnh commented 1 year ago

Is the link to the readthedocs page available somewhere? Maybe we can add it to the description?

alex-mitrevski commented 1 year ago

There is a page (https://mas-domestic-robotics.readthedocs.io/en/latest/), but I haven't added a link anywhere because the main branch is taken for the build; since these (incomplete) docs are currently only available on devel, the page is empty.

We could, of course, merge devel into noetic; I guess it's time for that anyway...

minhnh commented 1 year ago

OK then let me wrap up the code for simple base and arm motions, then we can do a new release. Last one was in 2020 :smile:.