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

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

Closed
evan-palmer opened this issue Jun 20, 2023 · 2 comments
Closed

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

evan-palmer opened this issue Jun 20, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation high priority This is a high priority issue

Comments

@evan-palmer
Copy link
Collaborator

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.

@evan-palmer evan-palmer added documentation Improvements or additions to documentation low priority This is a low priority issue labels Jun 20, 2023
@evan-palmer evan-palmer added mid priority This is a medium priority issue high priority This is a high priority issue and removed low priority This is a low priority issue mid priority This is a medium priority issue labels Jul 22, 2023
@evan-palmer evan-palmer added needs triage This issue needs triage support and removed high priority This is a high priority issue labels Aug 21, 2023
@evan-palmer evan-palmer self-assigned this Sep 6, 2023
@evan-palmer evan-palmer added high priority This is a high priority issue and removed needs triage This issue needs triage support labels Sep 6, 2023
@abubake
Copy link

abubake commented Oct 17, 2023

Looking forward to seeing some great documentation with this project!

@evan-palmer
Copy link
Collaborator Author

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.

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 high priority This is a high priority issue
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants