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

📝 Add user guide file to docs #679

Merged
merged 1 commit into from
Nov 1, 2024
Merged

📝 Add user guide file to docs #679

merged 1 commit into from
Nov 1, 2024

Conversation

dalonsoa
Copy link
Contributor

Description

Adds the existing user_guide.md file to the MkDocs documentation, so it is rendered alongside everything else. This file is just a placeholder. Populating the guide will be done in #350 .

Fixes #346

Type of change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Documentation (non-breaking change that adds or improves the documentation)
  • Optimisation (non-breaking, back-end change that speeds up the code)

Key checklist

  • Pre-commit hooks run successfully (pre-commit run -a)
  • All tests pass (pytest)
  • The documentation builds without warnings (mkdocs build -s)
  • Check the GUI still works (if relevant)
  • Check the code works with actual hardware (if relevant)
  • Check the pyinstaller-built executable works (if relevant)

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests have been added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

@dalonsoa dalonsoa requested a review from alexdewar October 31, 2024 11:44
Copy link

codecov bot commented Oct 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.99%. Comparing base (f014b51) to head (550c79f).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #679   +/-   ##
=======================================
  Coverage   84.99%   84.99%           
=======================================
  Files          69       69           
  Lines        3459     3459           
=======================================
  Hits         2940     2940           
  Misses        519      519           

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

Copy link
Collaborator

@alexdewar alexdewar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@alexdewar alexdewar merged commit d92801b into main Nov 1, 2024
8 checks passed
@alexdewar alexdewar deleted the user_guide branch November 1, 2024 10:55
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.

Include user guide on GitHub Pages
2 participants