Add Markdown linting to CI

[chykon]

Description & Motivation

RELATED TO https://github.com/intel/rohd/pull/279

The motivation for the proposed changes is to make it easier to write collaboratively Markdown.

It is proposed to add a new step to CI to allow parsing Markdown files for formatting issues or deprecated features that may not be handled correctly by some parsers.

Additionally, it is proposed (https://github.com/intel/rohd/pull/279) to add an extension that will allow you to correct errors when working with Markdown in an interactive form and in real time.

---

ISSUES

Run revealed a large number of errors. Most can be fixed automatically (eg MD034/no-bare-urls), but some require tweaking (eg string length). For now, it is recommended to install the extension from https://github.com/intel/rohd/pull/279 and apply document formatting (RMB -> Format Document).

Perhaps some rules need to be redefined. For example, a string length of 80 characters seems too short for Markdown documents. Tell me which rules need to be overridden and I will prepare the appropriate configuration for CI/extension.

Related Issue(s)

No.

Testing

You can examine the run results here: https://github.com/chykon/rohd/actions/runs/4217962760/jobs/7322121795.

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

No.

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

To be able to merge, you will need to correct the formatting of most Markdown files (which is a significant part of the documentation).

[chykon]

Made a set of rules. Explanation:

• The .markdownlint-cli2.jsonc config is located like this because the markdonwlint extension looks for the config at the root.
• The MD013 rule is disabled because the line length limit seems pretty useless in a Markdown context. Even the default markdownlint extension disables this rule.
• The MD041 rule is disabled because we don't always need a first level header at the beginning (eg .github/PULL_REQUEST_TEMPLATE.md, CHANGELOG.md).
• Ignore doc/api/ because that's where the generated Markdown file is located.

With the current set of rules, almost all errors can be corrected automatically, only small fragments will require manual editing.

[chykon]

Restart testing required.

[chykon]

Forgot to sync changes. Sorry :)