Docs/markdown broken links

[cheriimoya]

This PR will

1. fix all currently broken links,
2. add a pipeline to the project to automatically check for broken links in any markdown files and
3. improve the documentation on three lines.

I'd be happy to add more value to the project (especially documentation wise).