WIP User Guide

[JuliaPoo]

This pull mostly:

1. Fix factual errors in the UG
2. Established a format for the documentation of each command
   • E.g., with regards to communicating the format of each command, just modify the LATEX given for edit or add.
3. Restructured the Features section.

The old UG is in the file UserGuide.md.old

There are still many issues to be fixed. Refer to #83.

Currently the User Guide looks like this. There is still a lot to be done, especially regarding documenting each of the commands to a satisfactory standard.

The absolutely most time consuming thing right now, is to document each command properly. Please refer to edit and add where I've partially done up the documentation (still missing potential failures section for each), as a reference for documenting other commands.

Furthermore, there are still a few missing sections. Refer to the notes in #83. E.g., a section with an explanation of the GUI elements of the UG itself.

Furthermore, there are definitely small things to take note of, such as broken links, and a more informal language.

[Fidget-Spinner]

One minor comment, else LGTM.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.73%. Comparing base (96a3e71) to head (7410ed3).

Additional details and impacted files

@@            Coverage Diff            @@
##             master     #192   +/-   ##
=========================================
  Coverage     65.73%   65.73%           
  Complexity      555      555           
=========================================
  Files            95       95           
  Lines          2174     2174           
  Branches        219      219           
=========================================
  Hits           1429     1429           
  Misses          663      663           
  Partials         82       82           

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

[JuliaPoo]

In addition to fixing checkstyle, I added a broken links detector:

by appending the following code at the bottom of the page:

<script>
let meow = [...document.getElementsByTagName("a")].filter(a => a.href.includes("#")).filter(a => document.getElementById(a.href.split("#")[1]) === null).map(a => `  -- [${a.textContent}](${a.href.split("#")[1]})`).join("\n");
if (meow !== "") alert(`Broken links:\n${meow}`)
</script>

EDIT: OK SO THE ABOVE IS WRONG, SEE #193