Skip to content

Documentation sources are not linted in CI #8480

Description

@emyller

Documentation pull requests pass CI with formatting and Markdown quality defects which should be caught before review. The docs CI workflow only builds the site (.github/workflows/docs-pull-request.yml); the existing lint Makefile target (docs/Makefile) and the repository pre-commit prettier hook (.pre-commit-config.yaml) are never run by CI. As a result, the current documentation sources already fail formatting on 151 files and carry thousands of Markdown lint findings.

Acceptance criteria

  • All current documentation sources under docs/ pass formatting and Markdown lint checks.
  • A documentation pull request that introduces a formatting or Markdown lint defect fails CI.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocsDocumentation updates

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions