doc: Update doc and lint it

[gmuloc]

Description

cf title

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have run pre-commit for code linting and typing (pre-commit run)
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes (tox -e testenv)

[codspeed-hq]

CodSpeed Performance Report

Merging #847 will not alter performance

_{Comparing gmuloc:ci-add-markdownlint (d41efc4) with main (3408217)}

Summary

✅ 4 untouched benchmarks

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud