As a doc contributor, I would like assistance to improve content quality and style so that it adheres to the preferred Quarkus community style. When I raise a PR, I would like my content to be automatically checked by the Vale linter so that critical content styling issues are detected and fixed before the PR is merged.

Questions

• Which Vale style ruleset should we start with as our baseline?

• • Vale’s official publicly available styles are the Google and Microsoft style. Vale-at-red-hat a community-supported ruleset, for which we have good internal support and resources.

• How strict do we want the Vale PR validation check to be?
  • PR cannot be merged unless ...
• What are the most important style issues that we always want to catch and fix before a PR is merged?
• What Quarkus style issues are considered to be a) errors, b) warnings, and c) suggestions?

Why use the Vale linter/style-checker?

• It’s free open-source software (FOSS) that you can download from GitHub.
• When you run Vale, it lints each line in your document and flags style issues using three categories: suggestions, warnings, and errors.
• Easily configurable and the style guide rulesets (YAML) are customizable. We can create our own Quarkus ruleset or we can customize the Red Hat / Google style set.
• (Docs-as-code) Vale is boon for “Docs-as-code” community, because it uses similar tools and processes followed in writing and compiling code.
• Vale is not a writing aid tool like Grammarly. It's a style-checker.