docs: integrate Vale for documentation linting (#2242)

* added value rules

* resolved errors raised by vale

* added github action

* fixes to github action

* added details in contribution guidelines

* added rule for numbers

* limited checks to errors
This commit is contained in:
Shahed Nasser
2022-09-22 13:12:09 +03:00
committed by GitHub
parent d0d789b6d4
commit 6adaf56c73
103 changed files with 2408 additions and 832 deletions
+14
View File
@@ -0,0 +1,14 @@
extends: existence
message: "Numbers must be spelled out"
link: https://medusajs.notion.site/Style-Guide-Docs-fad86dd1c5f84b48b145e959f36628e0#24a7270d3eee4d8e97657b0e12cd979a
level: error
ignorecase: true
scope: paragraph
tokens:
- '.*[0-9]+\s(?!(AM|PM))+' #need to match words before to add exceptions
- '.*[0-9][.]'
exceptions:
- '[pP]ort [0-9]+'
- 'WSL2'
- '[vV]ersions? [0-9]'
- '[v.]+[0-9]+'