Bug 7945 - Documentation has spelling errors
Summary: Documentation has spelling errors
Status: NEW
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: PC Unknown
: P2 Normal
Target Milestone: MediumPrio
Assignee: Bugzilla mail exporter
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-06-10 15:51 CEST by Pierre Ossman
Modified: 2022-06-14 12:39 CEST (History)
0 users

See Also:
Acceptance Criteria:


Attachments

Description Pierre Ossman cendio 2022-06-10 15:51:14 CEST
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
Comment 1 Pierre Ossman cendio 2022-06-10 15:51:55 CEST
This should also make it easier to enforce British vs American spelling (bug 5561).
Comment 2 Pierre Ossman cendio 2022-06-10 15:57:01 CEST
(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.

Note You need to log in before you can comment on or make changes to this bug.