Improved user guide, added CI vale for docs (#2308)

* restructured user guide, minor fixes * added index file for user guide * github actions for vale * testing workflow * CI vale * changes as per vale's suggestions * set CI vale on pull request * adding homebrew script to macos infra setup file * fix CI errors * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * testing vale * vale testing complete * vale cleanup * vale test * vale test for github-pr-check * vale test for github-pr-check * vale test for github-pr-check * vale test for github-pr-check * testing vale warnings * testing vale warnings * testing vale warnings * testing vale warnings * testing vale warnings * testing vale warnings * testing vale warnings * swizzled doc cards to add icons * Align CI params to other CIs --------- Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
2023-11-03 21:02:30 +05:00
parent c397619100
commit 2221c68dff
52 changed files with 219 additions and 11 deletions
--- a/.github/styles/docs/Numbers.yml
+++ b/.github/styles/docs/Numbers.yml
@ -0,0 +1,13 @@
+extends: existence
+message: "Numbers must be spelled out"
+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]+'