Flagsmith / Flagsmith/flagsmith

Documentation sources are not linted in CI

Open
#8,480 1 comment 0 reactions 0 assignees View on GitHub
bug docs
Dominant language
Python
Stars
6.6k
Forks
567
Avg merge
1d 13h
Merged PRs (30d)
121

Description

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`](https://github.com/Flagsmith/flagsmith/blob/main/.github/workflows/docs-pull-request.yml)); the existing `lint` Makefile target ([`docs/Makefile`](https://github.com/Flagsmith/flagsmith/blob/main/docs/Makefile)) and the repository pre-commit prettier hook ([`.pre-commit-config.yaml`](https://github.com/Flagsmith/flagsmith/blob/main/.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.

Contributor guide

Open the contributing guide

Research direction

Start with .github/workflows/docs-pull-request.yml, then inspect the lint target in docs/Makefile and the prettier hook in .pre-commit-config.yaml. Run the existing documentation lint checks, resolve the current formatting and Markdown findings under docs/, and verify that a documentation pull request with a lint defect fails CI.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, markdown
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.