Add Vale for linting prose (#67)

Co-authored-by: Mahmoud Abdelrazek <[email protected]>

Author: paddyroddy

.github/workflows/linting.yaml

@@ -16,3 +16,8 @@ jobs:
       - uses: paddyroddy/.github/actions/linting@232a2f3869501abb249d50e311179f98830c6481 # v0
         with:
           pre-commit-config: ./.pre-commit-config.yaml
+
+      # yamllint disable-line rule:line-length
+      - uses: paddyroddy/.github/actions/vale@d5aea086eaabccae4bcf39786ad5138b629755a6 # v0
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1 +1,7 @@
+!.github/styles/config/
+!.github/styles/config/vocabularies/
+!.github/styles/config/vocabularies/Base
+.github/styles/*
+.github/styles/config/*
+.github/styles/config/vocabularies/*
 website/index.html

.vale.ini

@@ -0,0 +1,30 @@
+StylesPath = .github/styles
+
+# https://github.com/errata-ai/packages
+Packages = proselint,\
+           write-good
+
+[formats]
+twee = md
+
+[*.{md,twee}]
+BasedOnStyles = proselint,\
+                Vale,\
+                write-good
+
+# Disable
+Vale.Spelling = NO
+write-good.E-Prime = NO
+write-good.Passive = NO
+write-good.TooWordy = NO
+
+# Ignore lines starting with GitHub alerts syntax
+BlockIgnores = (?s)> \[!(CAUTION|IMPORTANT|NOTE|TIP|WARNING)\](\n|$)
+
+# `vale sync` in CI means the packages are then linted, so turn them off
+[.github/styles/**]
+BasedOnStyles =
+
+# Don't modify generated files
+[**/{CODE_OF_CONDUCT,LICENSE}*]
+BasedOnStyles =

story/choose-a-database.twee

@@ -61,16 +61,16 @@ Can you structure your data well in rows and columns?
 
 
 :: explore-no {"position":"1325,825","size":"100,100"}
-But you said you didn't know what questions to ask!
+You said you didn't know what questions to ask!
 
 If you know your wishes, [[ask the genie|question-yes]]!
 
 
 
 :: explore-yes {"position":"1325,925","size":"100,100"}
-You put the lamp in your pack and continue down the road. After some time you arrive at a watering hole. There is a friendly looking elephant drinking, and a dolphin pops its head above the water.
+You put the lamp in your pack and continue down the road. After some time you arrive at a watering hole. A friendly looking elephant is drinking, and a dolphin pops its head above the water.
 
-...choose a <a href="https://en.wikipedia.org/wiki/Relational_database">relational DB</a>.
+…choose a <a href="https://en.wikipedia.org/wiki/Relational_database">relational DB</a>.
 
 Popular choices: Postgres and MySQL.
 
@@ -124,7 +124,7 @@ Is your data media files? (Video, pictures, PDFs, specialised formats like nifti
 
 :: network-yes {"position":"1050,1050","size":"100,100"}
 The wizard calls his familiar, a large fuzzy spider. It hands you a magical spider web which speeds up the process of cataloguing the spells.
-

+
  Consider using a <a href="https://en.wikipedia.org/wiki/Graph_database">Graph database</a>.
 
 
@@ -179,7 +179,7 @@ Do you know exactly what question to ask? (For example, how many students have a
 
 
 :: text-no {"position":"900,1475","size":"100,100"}
-You find a mysterious map in the library. After following it, you arrive at a watering hole. There is a friendly looking elephant drinking, and a dolphin pops its head above the water.
+You find a mysterious map in the library. After following it, you arrive at a watering hole, where a friendly looking elephant is drinking and a dolphin pops its head above the water.
 
 Use a <a href="https://en.wikipedia.org/wiki/Relational_database">relational database</a>. Popular choices: <a href="https://en.wikipedia.org/wiki/PostgreSQL">Postgres</a> and <a href="https://en.wikipedia.org/wiki/MySQL">MySQL</a>.