Marcel Amirault authored 5 years ago and Evan Read committed 5 years ago

Clean up issues that may cause the docs-lint
test to fail, such as trailing whitespace, no
EOF newline, blockquotes, etc

Many code blocks are 4spaced, and they render in GitLab
without coloring as a result, even though they are
fenced with a language label. If in a list, other items
will render as being in a code block too, even if not
meant to. This fixes all these issues, and cleans up
minor white space issues in /topic, /university, /update
and /workflow docs.

Marcel Amirault authored 5 years ago and Evan Read committed 5 years ago

Correct the spacing of unordered markdown lists
in docs, to maintain standards of documentation.

Marcel Amirault authored 5 years ago and Achilleas Pipinellis committed 5 years ago

All code blocks should be surrounded by blank lines

Evan Read authored 5 years ago and Achilleas Pipinellis committed 5 years ago

Also improves the markdown in that section.

Evan Read authored 6 years ago and Achilleas Pipinellis committed 6 years ago

Markdown renderers find it easier to determine
where lists start and end when lists are surrounded
by new lines.

For consistency, also ensure entries in the list
are aligned when they span multipls lines.

Evan Read authored 6 years ago and Achilleas Pipinellis committed 6 years ago

For the sake of consistency, removes any extraneous
consecutive blank lines from the doc suite.

- Also makes other minor Markdown fixes that were near the main fixes.

Also corrects capitalisation of Git.

[ci skip]