Fix various spelling mistakes and put tooling in place to make this easier in the future.
Why
As I was browsing the docs, I noticed a number of spelling mistakes. This is an international project, so many (most?) contributors do not speak English as their mother language. This change fixes mistakes, adopts a common locale (en-GB) for consistency's sake, and puts a configuration in place for the cspell utility to be used.
How
Ran npx cspell **/*.md until the report is successful, either electing to add the words to the dictionary or to fix the spelling of the words in place.
My IDE also auto-regenerated the ToC for the compiling.md file, which is why there were incidental changes there as well.
Future work
I noted in this change where different contributors have followed different markdown conventions over time, which results in unnecessary changes being introduced as edits are made. Ill look to implement prettier to the project and have it run as a pre-commit hook to help keep things consistent. Also, implementing cspell as a github action is a reasonable future action once we validate that the dictionary is not expensive to maintain.
What
Fix various spelling mistakes and put tooling in place to make this easier in the future.
Why
As I was browsing the docs, I noticed a number of spelling mistakes. This is an international project, so many (most?) contributors do not speak English as their mother language. This change fixes mistakes, adopts a common locale (en-GB) for consistency's sake, and puts a configuration in place for the
cspellutility to be used.How
Ran
npx cspell **/*.mduntil the report is successful, either electing to add the words to the dictionary or to fix the spelling of the words in place.My IDE also auto-regenerated the ToC for the
compiling.mdfile, which is why there were incidental changes there as well.Future work
I noted in this change where different contributors have followed different markdown conventions over time, which results in unnecessary changes being introduced as edits are made. Ill look to implement prettier to the project and have it run as a pre-commit hook to help keep things consistent. Also, implementing cspell as a github action is a reasonable future action once we validate that the dictionary is not expensive to maintain.