Skip to content

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

@Tejassveer08

Description

@Tejassveer08

Description:
The repository lacked automated documentation quality checks, leading to inconsistent Markdown styling and the risk of broken external links slipping into PRs. This feature request introduces standardized linting and link validation to improve docs reliability and contributor experience.

Proposed solution:
Add a GitHub Actions workflow to run Markdown linting and external link checks on all PRs touching .md files.

Add shared configurations for markdownlint and lychee at the repo root.

Document how to run these checks locally in CONTRIBUTING.

Acceptance criteria:

A CI workflow runs on PRs and fails when markdown rules are violated or external links are broken.
Linting and link-check configs live at repo root and are used by the workflow.
CONTRIBUTING includes clear instructions for running these checks locally.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions