We don't do any spell checks on the product documentation, which means that errors do creep in now and then. This lowers the overall impression of not just the documentation, but the product as a whole. So we would like to remedy this and have a proper spell check of everything. There is an extension for Sphinx that does spell checking using Enchant: https://sphinxcontrib-spelling.readthedocs.io/en/latest/ However, these days there are also grammar checking tools, such as LanguageTool¹. So we might want to pass the data through such a tool to get both the grammar and spelling checked. ¹ https://languagetool.org
This should also make it easier to enforce British vs American spelling (bug 5561).
(In reply to Pierre Ossman from comment #0) > There is an extension for Sphinx that does spell checking using Enchant: > > https://sphinxcontrib-spelling.readthedocs.io/en/latest/ A quick run of this gives 737 hits. Many things are false positives (like product names), but there are also many actual problems found.
There is this language server (and extension for vscode) that can be used for reStructuredText: https://valentjn.github.io/ltex/ It supports using our LanguageTool Premium accounts for better checks. It requires another language server to parse reStructuredText files, though, which is crashing on some of our files: https://github.com/swyddfa/esbonio/issues/714 The above doesn't give us automatic checks, but it can at least help whilst actively working on the documentation.
FWIW, another option is just copying and pasting portions of the rendered HTML into LanguageTools web spell checker. As it handles rich text, it works really well.
The tag has now been spell and grammar checked using LanguageTool.
Went through all the grammar and spelling corrections of the documentation. Generally it looks very good, with two exceptions: * client_macos.rst: singular AltGr followed by 'were' * tl-config.1.rst: incorrect indentation under --all-entries option Reopening to get this fixed.
Issues mentioned in comment 13 have been resolved. Closing.
