search

Robotic-Decision-Making-Lab / blue

ROS 2 platform for underwater robotics research and development.
https://robotic-decision-making-lab.github.io/blue/
MIT License
44 stars 10 forks source link

[DOC]: Host user documentation using Github Pages #31

Closed evan-palmer closed 4 months ago

evan-palmer commented 1 year ago

Documentation Change Type

Adding new documentation to the BlueROV2 driver documentation

Documentation Location

An initial version of the user documentation should be generated for the full project.

Documentation Problem

There is currently no user documentation introducing the project or how to use it.

Suggested Change

Create a user documentation website that describes how to use the project. If possible, it may be worth embedding the developer documentation into the site as well. However, if the theme of choice is not compatible with Doxygen, then the two should be kept separate.

abubake commented 10 months ago

Looking forward to seeing some great documentation with this project!

evan-palmer commented 10 months ago

This is finally in-progress. I made an orphan gh-pages branch that will be maintained separately from the main branch. I'll close this once I have an initial release ready and published.