Added information on how to manage spelling errors in the docs (#760)

People are unsure on how to handle the spelling bot errors.
This commit is contained in:
Ruben Olsen Lærk
2025-07-31 08:35:39 +02:00
committed by GitHub
parent 27a632d186
commit 76c0e615af
2 changed files with 12 additions and 0 deletions

View File

@@ -247,6 +247,18 @@ Place the content inside the details-tags.
</details>
## How To Fix Spelling Errors
As part of the build process, GitHub actions runs a spell checker bot on the documentation. If the bot finds any spelling error, it will be reported in the build output on GitHub. You must fix this by editing the file and correcting the spelling error.
![Image of spelling bot error](/static/img/repo/spellingbot-example.png)
If the bot mistakes a word, you can add it to the `/.github/actions/spelling/allow/keywords.txt` file.
This will prevent the bot from reporting this word as a spelling error in the future.
## Naming Standards

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB