Automatic docs linter for style consistency

Hello everyone!

We’ve been having conversations for a while now about how helpful it would be to have an automatic linter to check that documentation in PRs follows the documented style. This idea has come up in different contexts, including discussions around a potential GSoC project (though that’s not the case at this stage). There’s general agreement that this would be a good step forward to reduce time and roundtrips during reviews.

Currently, style guidelines for docs are well documented, but checking them is still a manual part of the review process. That often results in extra back-and-forth over small formatting details, which can slow things down. Automating this would help ease that overhead, making reviews more efficient for both contributors and maintainers.

Luckily for us, @smithdc1 has submitted a PR to introduce an automatic linter for the Django documentation :green_heart:, with the goal of making docs style enforcement more consistent and streamlined.

This is in the same spirit as previous efforts to improve formatting consistency, though in this case, it applies specifically to documentation, where the style rules are already established. The goal is to automate checks, not to change expectations.

The Fellows plan to land this PR before 6.0 feature freeze, with no intention to backport changes to 5.2.x or other former stable branches. While most changes won’t invalidate translations, we don’t see significant benefit in backporting since future docs updates are unlikely to cause many conflicts: the majority of lint changes are line wrapping fixes.

This is mainly an FYI, but if you have concerns or thoughts, please feel free to share them so they can be taken into account.

Thanks!

5 Likes