[#386] Add markdownlint check to CI

[orecham]

Notes for Reviewer

1. Tweak .markdownlint.yaml to match convention of existing documents as much as possible
2. Add a script to check and fix (as much as possible) markdownlint violations: internal/scripts/check_markdown_linting.sh
   1. Check violations with --check
   2. Fix violations with --fix
      1. NOTE: The fixing is not perfect, the line length fix can sometimes mess desired formatting
      2. It is however, quicker to bulk fix line lengths and manually fix any undesired formatting then to manually fix all line length violations
3. Fix all violations in existing documents
4. Check markdown linting (in added or modified files) in CI

Pre-Review Checklist for the PR Author

1. [x] Add sensible notes for the reviewer
2. [x] PR title is short, expressive and meaningful
3. [x] Relevant issues are linked in the References section
4. [ ] Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
5. [x] Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
6. [x] Commits messages are according to this guideline
   • [x] Commit messages have the issue ID ([#123] Add posix ipc example)
   • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
7. [ ] Tests follow the best practice for testing
8. [ ] Changelog updated in the unreleased section including API breaking changes
9. [x] Assign PR to reviewer
10. [x] All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

• [ ] Commits are properly organized and messages are according to the guideline
• [ ] Unit tests have been written for new behavior
• [ ] Public API is documented
• [ ] PR title describes the changes

Post-review Checklist for the PR Author

1. [ ] All open points are addressed and tracked via issues

References

Closes #386

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 79.50%. Comparing base (fdb27fe) to head (d565e44). Report is 1 commits behind head on main.

Additional details and impacted files

[](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/387?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) ```diff @@ Coverage Diff @@ ## main #387 +/- ## ========================================== + Coverage 79.47% 79.50% +0.02% ========================================== Files 193 193 Lines 22716 22716 ========================================== + Hits 18054 18060 +6 + Misses 4662 4656 -6 ``` [see 3 files with indirect coverage changes](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/387/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)