File tree Expand file tree Collapse file tree 1 file changed +18
-0
lines changed Expand file tree Collapse file tree 1 file changed +18
-0
lines changed Original file line number Diff line number Diff line change @@ -31,6 +31,21 @@ Once setup, the site will be accessible on http://localhost:4000/docs/
31
31
When you' ve made a change, either push it to a forked repository, or to a
32
32
feature branch, and [raise a pull request][raise-a-pr].
33
33
34
+ ### Spellings
35
+
36
+ Spell checking is provided via [`cspell`][cspell], a library which integrates
37
+ with a number of code editors. Checking is run automatically on pull requests.
38
+
39
+ If you' re using VSCode, be sure to [install Code Spell Checker][vscode-cspell].
40
+
41
+ To run the checks manually (this is optional) you' ll need to:
42
+
43
+ 0. install [NodeJS & `npm`][install-node]
44
+
45
+ 1. run `npm test`
46
+
47
+ New spellings can be added to `.spelling`. Be sure to spell added words correctly!
48
+
34
49
### Navigation Sidebar
35
50
36
51
The docs navigation sidebar is generated from `_data/sidebar_tree.yaml` as part
@@ -42,3 +57,6 @@ page titles.
42
57
[clone-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
43
58
[install-ruby]: https://www.ruby-lang.org/en/documentation/installation/
44
59
[raise-a-pr]: https://github.com/srobo/docs/pull/new/master
60
+ [cspell]: https://cspell.org/
61
+ [vscode-cspell]: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
62
+ [install-node]: https://downloads.nodesource.com/
You can’t perform that action at this time.
0 commit comments