Skip to content

Add docs quality gates for Markdown changes#2431

Open
fabthebest wants to merge 2 commits into
huggingface:mainfrom
fabthebest:docs-quality-gates
Open

Add docs quality gates for Markdown changes#2431
fabthebest wants to merge 2 commits into
huggingface:mainfrom
fabthebest:docs-quality-gates

Conversation

@fabthebest
Copy link
Copy Markdown

@fabthebest fabthebest commented Apr 23, 2026

Summary

  • add a repo-wide GitHub Actions workflow that runs on Markdown changes in pull requests and on pushes to main
  • lint only the Markdown files changed in a PR to avoid blocking contributors on unrelated pre-existing docs debt
  • validate external links for those changed Markdown files with a shared lychee configuration
  • add shared root configuration for markdownlint-cli2 and lychee
  • document the local docs quality workflow in CONTRIBUTING.md and link to it from the README

Why

This addresses the lack of automated docs quality gates in the repository and reduces the risk of inconsistent Markdown styling or broken external links slipping into merged changes.

Validation

  • ran markdownlint-cli2 locally on the edited Markdown files
  • verified the external links referenced in README.md and CONTRIBUTING.md resolve successfully

Closes #2005

Drafting assistance from Codex; workflow design, testing, and final review done by me.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 3715839. Configure here.

Comment thread .github/workflows/docs_quality.yml Outdated
Comment thread .github/workflows/docs_quality.yml
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.

Add repo-wide docs quality gates: Markdown linting and external link checks

1 participant