diff options
Diffstat (limited to 'documentation/standards.md')
| -rw-r--r-- | documentation/standards.md | 15 |
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 | ||
| 6 | It is currently a work in progress. | 6 | It is currently a work in progress. |
| 7 | 7 | ||
| 8 | ## Automatic style validation | ||
| 9 | |||
| 10 | There is an ongoing effort to automate style validation | ||
| 11 | through the [Vale](https://vale.sh/). To try it, run: | ||
| 12 | |||
| 13 | $ make stylecheck | ||
| 14 | |||
| 15 | Note that this just applies to text. Therefore, the syntax | ||
| 16 | conventions described below still apply. | ||
| 17 | |||
| 18 | If you wish to add a new word to an "accept.txt" file | ||
| 19 | (./styles/config/vocabularies/<Vocab>/accept.txt), | ||
| 20 | make sure the spelling and capitalization matches | ||
| 21 | what Wikipedia or the project defining this word uses. | ||
| 22 | |||
| 8 | ## Text standards | 23 | ## Text standards |
| 9 | 24 | ||
| 10 | ### Bulleted lists | 25 | ### Bulleted lists |
