[Proposal] Add a CI job for enforcing consistent formatting for markdown files

[tigleym]

It would probably be a good idea to establish a way to ensure markdown files are formatted consistently. This will make it easier to write cleaner documentation. One idea is to use markdownlint, which is something previously used in the Theta Wave project when we first started using mdBook.

[erlend-sh]

Sounds useful. As long as we’re not enforcing line endings I’m on board 😄

@orhun any opinions on this? Should we just replicate the Theta Wave approach?

[orhun]

@orhun any opinions on this? Should we just replicate the Theta Wave approach?

Yup, it seems applicable to me.

Not relevant to the CI job but maybe we can mention the usage of markdownlint-cli in the contributing docs or somewhere similar for people who would like to contribute to the documentation. So that they can spot the markdown formatting errors and fix them before they commit.