mirror of
https://github.com/actualbudget/actual.git
synced 2026-05-25 15:12:14 -05:00
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:
@@ -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.
|
||||
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
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
|
||||
|
||||
|
||||
BIN
static/img/repo/spellingbot-example.png
Normal file
BIN
static/img/repo/spellingbot-example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
Reference in New Issue
Block a user