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

Initiate a documentation page using github pages. #6

Closed
6 tasks done
smileisak opened this issue Jan 24, 2023 · 0 comments · Fixed by #12
Closed
6 tasks done

Initiate a documentation page using github pages. #6

smileisak opened this issue Jan 24, 2023 · 0 comments · Fixed by #12
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@smileisak
Copy link
Member

smileisak commented Jan 24, 2023

Objective: To create a documentation page for the Nauticus controller, to provide users with clear and comprehensive information about how to use the controller and its features.

  • Create a new repository on GitHub to hold the documentation files.
  • Use markdown files to write the documentation, covering topics such as installation, usage, and troubleshooting.
  • Use GitHub Pages to host the documentation, by enabling it on the repository settings.
  • Use a theme or template to make the documentation look good and easy to navigate.
  • Create a link to the documentation page in the main Nauticus repository.
  • Test the documentation page by visiting it and ensuring that all links work and the information is clear and correct.

Note: The documentation page will be the first point of contact for the users, it should be simple, clean and easy to navigate, it's important to keep it updated as the project evolves.

@smileisak smileisak self-assigned this Jan 26, 2023
@smileisak smileisak added the documentation Improvements or additions to documentation label Jan 26, 2023
@smileisak smileisak added this to the Release v0.1.0 milestone Jan 27, 2023
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant