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/write-good/E-Prime.yml
+++ b/.github/styles/write-good/E-Prime.yml
@ -0,0 +1,32 @@
+extends: existence
+message: "Try to avoid using '%s'."
+ignorecase: true
+level: suggestion
+tokens:
+  - am
+  - are
+  - aren't
+  - be
+  - been
+  - being
+  - he's
+  - here's
+  - here's
+  - how's
+  - i'm
+  - is
+  - isn't
+  - it's
+  - she's
+  - that's
+  - there's
+  - they're
+  - was
+  - wasn't
+  - we're
+  - were
+  - weren't
+  - what's
+  - where's
+  - who's
+  - you're