CI PR #7: docs: Fix Markdown format for proper markdown linting

[bernhardkaindl]

Topic: Fix GitHub CI

In this PR:

• Fix markdown format for proper markdown linting

Contents:

• Commit 1 from CI PR #1: Fix GitHub CI and 'tox' for local CI on Ubuntu 24.04 #143: (please review)

  • It has become impractical to use EOL versions like Python 2.7 & 3.6 in CI
  • It has become counterproductive to use pyre CI, disable it for now.
  • Move forward to run the unit tests with Python 3.11

• Commits 2,3 from CI PR #2: Fix GitHub CI and add checks to compensate for code coverage #144: (please review)

  • Compensate the code coverage by adding new checks
  • Fix two spelling typos in the comments

• Commit 4 from CI PR #3: Fix the 1st half of the pyright warnings in the unit tests #145: (please review)

  • Fix the 1st half of the pyright warnings in the unit tests

• Commit 5, 6, 7 and 8 from CI PR #4: Fix pylint and 2nd half of the pyright warnings #146: (please review)

  • Fix pylint and 2nd half of the pyright warnings
  • pyright: Bump Python version to check to 3.11
  • pyright: Fix ErrorHandler taking Response | None
  • pyright: Skip warning on renamed arg: FTPAccessor.access(name->path)

• Commits 9-13 from CI PR #5: Complete the transition from pyre to pyright #147: (please review)

  • tox.ini: Complete the transition from pyre to pyright
  • pre-commit: Remove the remaining call to pyre in pre-commit
  • docs: Complete the transition from pyre to pyright
  • tox.ini/pyright: Fail tox if pyright fails (enforce check)
  • pyre: Finally, remove obsolete pyre-error suppressions

• Commit 14-18 from CI PR #6: GitHub CI/tox: Update CI to use Python 3.11, 3.12 and 3.13 #148: (please review)

  • CI PR #6: GitHub CI/tox: Update CI to use Python 3.11, 3.12 and 3.13
  • Fix test_bootloader.py/pylint: assertRegexpMatches renamed to assertRegex
  • CONTRIBUTING.md: Add venv setup and using pipx
  • tests/test_logger.py: Use pyfakefs: don't create a file in the host
  • .github/workflows/main.yml: Cleanup obsolete code for Python 2.7/3.8

• Commit 19-22 from this PR:

  • CONTRIBUTING.md: Fix Markdown format for linting
  • README.md: Fix Markdown format for linting and update it
  • README-Unicode.md: Fix Markdown format for linting and update it
  • .pre-commit-config.yaml: Replace mdformat check with markdownlint-cli

Note:
If you have review comments, I'd like to apply them using the last PR in this series!

[coveralls]

Pull Request Test Coverage Report for Build 11862485265

Details

• 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
• 12 unchanged lines in 4 files lost coverage.
• Overall coverage decreased (-0.009%) to 83.661%

---

Files with Coverage Reduction	New Missed Lines	%
xcp/accessor.py	1	89.1%
xcp/xmlunwrap.py	2	92.31%
xcp/cpiofile.py	3	75.26%
xcp/compat.py	6	78.57%

Totals
Change from base Build 9109272969:	-0.009%
Covered Lines:	2806
Relevant Lines:	3354

---

💛 - Coveralls