ImperialCollegeLondon / FINESSE

A graphical user interface for controlling and monitoring an interferometer device
BSD 3-Clause "New" or "Revised" License
3 stars 1 forks source link

:memo: Add user guide file to docs #679

Closed dalonsoa closed 3 weeks ago

dalonsoa commented 3 weeks ago

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

Key checklist

Further checks

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.