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/Acronyms.yml
+++ b/.github/styles/docs/Acronyms.yml
@ -0,0 +1,84 @@
+extends: conditional
+message: "'%s' has no definition."
+level: warning
+ignorecase: false
+scope: paragraph
+# Ensures that the existence of 'first' implies the existence of 'second'.
+first: '\b([A-Z]{3,5})\b'
+second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
+# ... with the exception of these:
+exceptions:
+  - API
+  - ASP
+  - CLI
+  - CPU
+  - CMS
+  - CRM
+  - CSS
+  - CSV
+  - DEBUG
+  - DOM
+  - DPI
+  - FAQ
+  - GCC
+  - GDB
+  - GET
+  - GPU
+  - GQL
+  - GTK
+  - GUI
+  - HTML
+  - HTTP
+  - HTTPS
+  - IDE
+  - JAR
+  - JSON
+  - JSX
+  - LESS
+  - LLDB
+  - NET
+  - NOTE
+  - NVDA
+  - ORM
+  - OSS
+  - PATH
+  - PDF
+  - PHP
+  - POST
+  - RAM
+  - REPL
+  - RSA
+  - SCM
+  - SCSS
+  - SDK
+  - SQL
+  - SSH
+  - SSL
+  - SVG
+  - TBD
+  - TCP
+  - TODO
+  - URI
+  - URL
+  - USB
+  - UTF
+  - WSL
+  - XML
+  - XSS
+  - YAML
+  - ZIP
+  - AWS
+  - REST
+  - MDX
+  - NPM
+  - SMS
+  - SID
+  - VIP
+  - UPS
+  - RMA
+  - JSONB
+  - USD
+  - SASL
+  - SCRAM
+  - FIRST
+  - CORS