This PR adds a spelling checker. Implemented as a custom layer around aspell to deal with our somewhat unique markdown dialect.
What our custom tool does is render the markdown files to HTML, parse the HTML with custom logic and exceptions, then feed the text into aspell (GNU spell checker) to check for spelling errors, and then do a best effort to find the location of the spelling mistake in the markdown files.
Existing issues found be the spellchecker were resolved in one of the following ways:
Fixing the spelling in the docs
Adding correct jagron and shorthands to the .aspell.en.pws file
Adding markdown code backticks around code references, names and
commands
Adding tags around one-off unrecognized spelling which do
not need to be added to the .aspell.en.pws file.
This PR adds a spelling checker. Implemented as a custom layer around aspell to deal with our somewhat unique markdown dialect.
What our custom tool does is render the markdown files to HTML, parse the HTML with custom logic and exceptions, then feed the text into
aspell(GNU spell checker) to check for spelling errors, and then do a best effort to find the location of the spelling mistake in the markdown files.Existing issues found be the spellchecker were resolved in one of the following ways: