Add automated Markdown linting and link checking to improve documentation quality #2061
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2005
I added automated docs-quality checks to address the issue of inconsistent Markdown styling and unnoticed broken links.
What I implemented
A GitHub Actions workflow that runs on every PR touching *.md files.
Markdown linting using markdownlint-cli.
External link validation using lychee.
Shared config files (.markdownlint.json and lychee.toml) at the repo root.
Updated CONTRIBUTING.md with clear steps for running both checks locally.
Result
The repository now enforces consistent Markdown formatting, catches broken links automatically, and gives contributors the tools to validate their docs before opening a PR.