British-english spell checking of markdown and notebooks

[erikvansebille]

Description

This PR uses vale.sh to implement British-English spelling rules for only the markdown files and markdown notebooks cells - and checks these in pre-commit using the new pixi run docs-spelling.

So far, it seems 'light; in the sense that it only targets markdown and not code. Is this what we want, @VeckoTheGecko?

Checklist

• Closes Decide on English spelling rules (and add to docsguide)? #2376
• This PR targets the correct branch (main for normal development, v3-support for v3 support)

AI Disclosure

• This PR contains AI-generated content.
  • I have tested any AI-generated content in my PR.
  • I take responsibility for any AI-generated content in my PR.
  • Describe how you used it (e.g., by pasting your prompt): I asked CoPilot: "How do I best enforce that all tutorials in docs/user_guide use british english spelling?"

[VeckoTheGecko]

One of the difficulties with this is that it only checks part of the codebase (i.e., prose).

Not code variable/parameter names, not docstrings, and not comments.

To what degree we want spellchecking is worth considering. Perhaps CSpell would be a better option.

Happy to merge if you think its helpful (the tooling is orthogonal anyway). Merging the corrections themselves is already good.

[VeckoTheGecko]

Suggested change

	spell-check-tutorial-prose:
	qaqc:

[VeckoTheGecko]

Suggested change

	name: "Documentation: pixi run docs-spelling"
	name: "Additional QAQC (separate to pre-commit - pixi run more-qaqc)"

[VeckoTheGecko]

Suggested change

	docs-spelling = { cmd = "python tools/lint_british_english.py docs/user_guide/examples/tutorial*.ipynb docs/user_guide/examples/tutorial*.md docs/user_guide/getting_started/tutorial*.ipynb docs/user_guide/getting_started/tutorial*.md", description = "Check tutorial prose uses British English." }
	docs-spelling = { cmd = "python tools/lint_british_english.py docs/user_guide/examples/tutorial*.ipynb docs/user_guide/examples/tutorial*.md docs/user_guide/getting_started/tutorial*.ipynb docs/user_guide/getting_started/tutorial*.md", description = "Check tutorial prose uses British English." }
	more-qaqc = { depends-on = ["docs-spelling"], description = "Additional QAQC tooling separate to pre-commit hooks" }

[VeckoTheGecko]

I suggest we remove this in favour of using the GitHub action (avoiding doubling up on the file selection).

[VeckoTheGecko]

Suggested change

	- **Use British English in tutorial prose.** The Vale check covers Markdown files and Markdown cells in tutorial
	- Use British English. This is validated by a spellchecker that is run in CI.

Remove "in tutorial prose"? (from what we discussed this was intended to be a codebase-wide policy)