quarkusio / quarkus

Quarkus: Supersonic Subatomic Java.
https://quarkus.io
Apache License 2.0
13.36k stars 2.56k forks source link

Enhance Quarkus docs vale rules to fix false-positives and enhance content quality #34884

Open michelle-purcell opened 11 months ago

michelle-purcell commented 11 months ago

Description

Vale can help improve content quality by reducing the editing effort and PR churn to fix grammatical and critical style issues.

Today Vale is running on PRs in non-blocking mode. However:

This issue tracks another iteration of enhancements to the Vale implementation to identify the top false positives and fix them. Plus to add some further rules to address the most common issues that need to be fixed.

Implementation ideas

quarkus-bot[bot] commented 11 months ago

/cc @MichalMaler (docstyle,documentation), @ebullient (docstyle,documentation), @inoxx03 (docstyle,documentation), @rolfedh (docstyle,documentation), @sheilamjones (docstyle,documentation), @sunayna15 (docstyle,documentation)