Closed JuliaPoo closed 6 months ago
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 65.73%. Comparing base (
96a3e71
) to head (7410ed3
).
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
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
This pull mostly:
edit
oradd
.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
andadd
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.