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

Documentation #32

Closed
trappitsch opened this issue Jan 11, 2024 · 0 comments · Fixed by #36
Closed

Documentation #32

trappitsch opened this issue Jan 11, 2024 · 0 comments · Fixed by #36
Labels
documentation Improvements or additions to documentation

Comments

@trappitsch
Copy link
Contributor

With the controller_cli and the controller GUI version, the documentation as it is handled now just via readme files in the respective folders is getting clunky.
I started creating a website in the docs folder (generated by sphinx and currently deployed as a github page). All readme documentation should be transported over there.

One issue with github pages is, that I'm unclear on how versioning will work. If it is important to keep old versions, the docs might have to switch over to readthedocs.

The main readme on the page should in the future:

  • give details on the project
  • explain what modules are available (hardware, firmware, cli, gui, ...) and link to the correct page in the docs
  • explain how versioning works
  • status badges
@trappitsch trappitsch added the documentation Improvements or additions to documentation label Jan 11, 2024
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
1 participant