Investigate options for spellchecking (pre-commit hook? GitHub Action?)

[alexdewar]

It would be helpful to have spelling checked, especially in documentation.

Here are some solutions I've used before in some configuration or other:

• codespell
• cspell
• this GitHub Action

We need to make sure that it's not too difficult to configure and doesn't produce too many false positives, otherwise it will be more annoying than useful.

As with many of the other issues, this is something we could apply just to this repo or could also include in the template to run in users' repos too.

[djmaxus]

I fancy the idea of utilising markdownlint via some popular GitHub workflow such as super-linter remotely and respective VS Code extension locally by default.

What do you think?

[alexdewar]

@djmaxus This is about checking spelling rather than linting markdown files per se. I've added a proper description to the issue now.

[djmaxus]

I see now, thanks!
I already use CSpell via their VSCode extension, so I'm leaning towards it.