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

Docs creation and migration to readthedocs #35

Closed
wants to merge 4 commits into from
Closed

Docs creation and migration to readthedocs #35

wants to merge 4 commits into from

Conversation

trappitsch
Copy link
Contributor

@trappitsch trappitsch commented Jan 18, 2024

Move the documentation to readthedocs, as described in issue #32

Todo list:

  • Intro with project description
  • Explain how versioning works and start the changelog
  • Hardware build
  • Firmware
  • CLI
  • GUI
  • CLI API documentation
  • Check all internal links
  • Check all external link - if possible
  • Disable deployments on github repo site, remove old test deployments

Closes #32

Copy link

codecov bot commented Jan 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (caa2740) 79.44% compared to head (42e7968) 79.44%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #35   +/-   ##
=======================================
  Coverage   79.44%   79.44%           
=======================================
  Files           8        8           
  Lines         180      180           
=======================================
  Hits          143      143           
  Misses         37       37           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@trappitsch trappitsch closed this Jan 18, 2024
@trappitsch trappitsch reopened this Jan 18, 2024
@trappitsch
Copy link
Contributor Author

close and open PR to trigger readthedocs build

and use it on in .readthedocs.yaml
still many links need to be updated once all is done
@trappitsch trappitsch closed this Jan 19, 2024
@trappitsch trappitsch deleted the docs branch January 21, 2024 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation
1 participant