Skip to content

A local-first personal finance app

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

Ruben Olsen Lærk76c0e615af30
diff --git a/docs/contributing/writing-docs.md b/docs/contributing/writing-docs.md
index 7e34f1e466..bb07f01745 100644
--- a/docs/contributing/writing-docs.md
+++ b/docs/contributing/writing-docs.md
@@ -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
diff --git a/static/img/repo/spellingbot-example.png b/static/img/repo/spellingbot-example.png
new file mode 100644
index 0000000000..f4e370e4fc
Binary files /dev/null and b/static/img/repo/spellingbot-example.png differ