Skip to content

chore: add markdown linter#4004

Merged
ngjaying merged 1 commit intolf-edge:masterfrom
Elia-Renzoni:markdown-linter-4000
Feb 28, 2026
Merged

chore: add markdown linter#4004
ngjaying merged 1 commit intolf-edge:masterfrom
Elia-Renzoni:markdown-linter-4000

Conversation

@Elia-Renzoni
Copy link
Contributor

This PR adds a make target for running Markdown lint checks with the following features:

  • Checks for markdownlint-cli: If is not installed, it will automatically install it.
  • Requires NPM: If NPM is not available, the target fails immediately.
  • Targetable directories: By default, it lints the docs/ folder, but a custom target can be specified. Example: make markdown-lint target=./README.md
  • Auto-correction: It can automatically fix issues. Optionally, we could split this into two targets, one for checking only, and one for fixing.

Related Issue: #4000

Signed-off-by: Elia Renzoni <elia.renzoni03@gmail.com>
Copy link
Collaborator

@ngjaying ngjaying left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. The addition of a local markdown-lint target is helpful for development parity with CI.

@codecov
Copy link

codecov bot commented Feb 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.80%. Comparing base (5dee73c) to head (7d4fcb2).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4004      +/-   ##
==========================================
- Coverage   71.87%   71.80%   -0.08%     
==========================================
  Files         460      460              
  Lines       53183    53183              
==========================================
- Hits        38224    38184      -40     
- Misses      12024    12052      +28     
- Partials     2935     2947      +12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ngjaying ngjaying merged commit 4dfe777 into lf-edge:master Feb 28, 2026
61 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants