docs/readme (#1109)

* fix: node version

* chore: update Vale styles

* fix: update vale config

* fix: edit README

* wip

* better vertical rythm

* update vale

.tool-versions

@@ -0,0 +1 @@
+nodejs 16.18.0

.vale.ini

@@ -1,4 +1,21 @@
 StylesPath = ".vale/styles"
+Packages = Google, proselint, write-good, Readability
+Vocab = Awesome
+MinAlertLevel = suggestion
 
 [*.{rst,md}]
-BasedOnStyles = Google, 18F, proselint, Awesome
+BasedOnStyles = Vale, Google, write-good, proselint
+
+# Track readability scores
+Readability.FleschKincaid = YES
+Readability.AutomatedReadability = YES
+
+# Duplicate of `Google.Passive`
+write-good.Passive = NO
+write-good.E-Prime = NO
+
+# Ignore MysT reference labels
+BlockIgnores = (?:\(.+\)=)
+
+# Ignore MyST inline roles (\x60 = `)
+TokenIgnores = ({\w+}\x60.+\x60)

.vale/styles/Google/AMPM.yml

@@ -1,4 +1,3 @@
----
 extends: existence
 message: "Use 'AM' or 'PM' (preceded by a space)."
 link: 'https://developers.google.com/style/word-list'

.vale/styles/Google/Acronyms.yml

@@ -1,4 +1,3 @@
----
 extends: conditional
 message: "Spell out '%s', if it's unfamiliar to the audience."
 link: 'https://developers.google.com/style/abbreviations'

.vale/styles/Google/Colons.yml

@@ -1,8 +1,8 @@
----
 extends: existence
 message: "'%s' should be in lowercase."
 link: 'https://developers.google.com/style/colons'
 nonword: true
 level: warning
+scope: sentence
 tokens:
   - ':\s[A-Z]'

.vale/styles/Google/Contractions.yml

@@ -1,4 +1,3 @@
----
 extends: substitution
 message: "Feel free to use '%s' instead of '%s'."
 link: 'https://developers.google.com/style/contractions'

.vale/styles/Google/DateFormat.yml

@@ -1,4 +1,3 @@
----
 extends: existence
 message: "Use 'July 31, 2016' format, not '%s'."
 link: 'https://developers.google.com/style/dates-times'
@@ -7,6 +6,4 @@ level: error
 nonword: true
 tokens:
   - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}'
-  - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|
-    Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|
-    Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'
+  - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'

.vale/styles/Google/Ellipses.yml

@@ -1,4 +1,3 @@
----
 extends: existence
 message: "In general, don't use an ellipsis."
 link: 'https://developers.google.com/style/ellipses'