-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add vscode spell check extension #753
base: main
Are you sure you want to change the base?
docs: Add vscode spell check extension #753
Conversation
Add spell check extension in VSCode for rst files. If required more file types(or all) can be enabled for spell checking. Signed-off-by: Nicolae Dicu <Nicolae.Dicu.ext@qorix.ai>
License Check Results🚀 The license check preparation job ran successfully. Status: Click to expand output
|
The created documentation from the pull request is available at: docu-html |
Does it help or does it highlight half the text including lots of normal words that it is not ware of? |
Signed-off-by: Nicolae Dicu <Nicolae.Dicu.ext@qorix.ai>
Created ignore list for most false positives, so hopefully it will be more helpful now for correcting spell mistakes. |
@hoe-jo you have most experience with writing docs? Would that help? Currently docs are indeed difficult to read because of the many spelling mistakes. |
Improvement
Description
After reviewing the
process
documentation it seems that there are a lot of spell mistakes so I added the VSCode extension for rst spell checking.Related ticket
related #544 (improvement ticket)