summaryrefslogtreecommitdiffstats
path: root/documentation/standards.md
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-03-12 21:58:39 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-03-19 15:22:27 +0000
commite987c5151c34cb388cc1a106a21bdc118206cfac (patch)
tree9f121a698078e93094e3dcb0995f94a7912c4dc7 /documentation/standards.md
parent08081135175e26efb868653d7c9cfd6089576326 (diff)
downloadpoky-e987c5151c34cb388cc1a106a21bdc118206cfac.tar.gz
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>
Diffstat (limited to 'documentation/standards.md')
-rw-r--r--documentation/standards.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/documentation/standards.md b/documentation/standards.md
index 9f4771ebd9..e0c0cba83c 100644
--- a/documentation/standards.md
+++ b/documentation/standards.md
@@ -5,6 +5,21 @@ documentation is created.
5 5
6It is currently a work in progress. 6It is currently a work in progress.
7 7
8## Automatic style validation
9
10There is an ongoing effort to automate style validation
11through the [Vale](https://vale.sh/). To try it, run:
12
13 $ make stylecheck
14
15Note that this just applies to text. Therefore, the syntax
16conventions described below still apply.
17
18If you wish to add a new word to an "accept.txt" file
19(./styles/config/vocabularies/<Vocab>/accept.txt),
20make sure the spelling and capitalization matches
21what Wikipedia or the project defining this word uses.
22
8## Text standards 23## Text standards
9 24
10### Bulleted lists 25### Bulleted lists