summaryrefslogtreecommitdiffstats
path: root/documentation/standards.md
diff options
context:
space:
mode:
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 a2274f6d6e..d3b25adfab 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
10This section has not been filled yet 25This section has not been filled yet