Add Vale for content linting to the repo

.github/workflows/linting.yml

@@ -59,3 +59,17 @@ jobs:
           git add .
           pre-commit run --all-files --color always --verbose
         working-directory: cookie-template/python-template
+
+  lint-prose:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - name: Run Vale
+        uses: errata-ai/vale-action@d89dee975228ae261d22c15adcd03578634d429c # v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          filter_mode: nofilter
+          reporter: github-check

.gitignore

@@ -7,3 +7,11 @@
 python-template
 
 *.DS_Store
+
+# https://vale.sh/docs/keys/packages#vcs
+.github/styles/*
+!.github/styles/config/
+.github/styles/config/*
+!.github/styles/config/vocabularies/
+.github/styles/config/vocabularies/*
+!.github/styles/config/vocabularies/Base

.vale.ini

@@ -0,0 +1,24 @@
+StylesPath = .github/styles
+
+# https://github.com/errata-ai/packages
+Packages = proselint,\
+           write-good
+
+[*.md]
+BasedOnStyles = proselint,\
+                Vale,\
+                write-good
+
+# Disable
+Vale.Spelling = NO
+write-good.E-Prime = NO
+write-good.Passive = NO
+write-good.TooWordy = NO
+
+# `vale sync` in CI means the packages are then linted, so turn them off
+[.github/styles/**]
+BasedOnStyles =
+
+# Don't modify licence files
+[**/LICENSE*]
+BasedOnStyles =

tutorial.md

@@ -7,7 +7,7 @@
 
 ## ⚙️ Setting up dependencies for using template
 
 <details><summary>Click to expand... </summary> <!-- markdownlint-disable-line MD033 -->
 
 To use the template you will need to install the following software tools
 
@@ -198,7 +198,7 @@
 
 It is recommended to set up a project-specific [virtual environment](https://docs.python.org/3/tutorial/venv.html) whenever working on Python project. This allows you to install the versions of third-party packages the project requires without conflicting with the requirements of other projects you are developing.
 
 There are a variety of virtual environment management tools available for Python. One option is [uv](https://docs.astral.sh/uv), which you will have installed if you followed our detailed set-up instructions above, or may already have installed previously. `uv` is an extremely fast Python package and virtual environment manager that has API compatiblility with `pip` and the built-in virtual environment manager - [`venv`](https://docs.python.org/3/library/venv.html).
 
 Once you are in your `{project_slug}` directory, a virtual environment can be created by running the following in a terminal/command prompt window
 
@@ -270,7 +270,7 @@
 python -m pip install --upgrade pip
 ```
 
-Similar to `uv`, once the the environment is active, you can install the package in editable mode, along with both its required dependencies and optional sets of dependencies by running
+Similar to `uv`, once the environment is active, you can install the package in editable mode, along with both its required dependencies and optional sets of dependencies by running
 
 ```sh
 python -m pip install --editable ".[dev,docs,test]"