Fix markdown format with autoformatters

[Riksu9000]

I'm testing some autoformatters. They all seem to be opinionated and quirky. Here I've compiled the less opinionated changes to begin with.

Remove whitespace at the end of lines.
Remove leading space from unordered lists.
Enforce two newlines between sections.
Always use - for unordered lists.
Slightly tweaked tables.
Indentation fixes.
Escape special characters where necessary.

[Itai-Nelken]

This doesn't seem to be a problem in the files changed, but 2 spaces at the end of a line mean a newline, so they might have been put intentionally.

[JF002]

I'm OK with those changes, they'll make our docs more consistent. We'll probably want to specify those conventions in the documentation

Did you run a tool to make those changes automatically? If yes, I think it could be a good idea to document how to use it, provide a configuration file (like we did for clang-format/tidy), and maybe add it in the format workflow for Github Actions.

[Riksu9000]

@JF002 Absolutely. I was initially working on adding a markdown formatter check, but none of the formatters I tested produced the exact format I was expecting so I need to experiment some more. These are cherry picked changes which guidelines and autoformatters agree with, so we can focus on the small details later.

[NeroBurner]

While changing the docs, can we also use the "one sentence one line" rule for markdown. It makes the diffs much more readable, as a single word change won't lead to a whole paragraph diff as the text flows down to the next line

For GitHub we'd then need two spaces at the end of the line to keep the sentences in one paragraph (on GitLab one would need to put a blank line in between sentences to create a new paragraph)

[NeroBurner]

I've always kept to the "one sentence one line" rule for markdown. Makes diffs MUCH more readable and formatting won't mess with a small change

[Riksu9000]

I'm inclined to agree, but none of the formatters I tested so far support this. We'll have to discuss this later. This PR isn't intended to fix everything, but only the most obvious issues.

[NeroBurner]

two minor suggestions, after that I'm very happy with this PR. Thank you for making the docs much more coherent!

[JF002]

I'm OK with those changes. I think it would be a good idea to list those formatting rules in coding-convientions.md because I'll probably be the first one to forget about them ;-)