manuals: add initial stylechecks with Vale

Use the "Vale" (https://vale.sh) tool to perform text style checks
Run "make stylecheck" to run the checks.

This just checks the text, not the Sphinx syntax style choices.

(From yocto-docs rev: d145e1dc45dc0792c8b8f7e73500b56face1e710)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2024-03-12 21:58:39 +01:00
committed by Richard Purdie
parent 0808113517
commit e987c5151c
7 changed files with 54 additions and 1 deletions

View File

@@ -5,6 +5,21 @@ documentation is created.
It is currently a work in progress.
## Automatic style validation
There is an ongoing effort to automate style validation
through the [Vale](https://vale.sh/). To try it, run:
$ make stylecheck
Note that this just applies to text. Therefore, the syntax
conventions described below still apply.
If you wish to add a new word to an "accept.txt" file
(./styles/config/vocabularies/<Vocab>/accept.txt),
make sure the spelling and capitalization matches
what Wikipedia or the project defining this word uses.
## Text standards
### Bulleted lists