File tree Expand file tree Collapse file tree 1 file changed +11
-4
lines changed Expand file tree Collapse file tree 1 file changed +11
-4
lines changed Original file line number Diff line number Diff line change @@ -35,18 +35,25 @@ using, which may present a security risk.
35
35
When you' ve made a change, either push it to a forked repository, or to a
36
36
feature branch, and [raise a pull request][raise-a-pr].
37
37
38
- # ## Spellings
38
+ # ## Validation
39
+
40
+ We have a number of checks which run against the docs to ensure they are ready
41
+ to publish, including internal links checks and spelling checks.
39
42
40
43
Spell checking is provided via [` cspell` ][cspell], a library which integrates
41
44
with a number of code editors. Checking is run automatically on pull requests.
42
45
43
- If you' re using VSCode, be sure to [install Code Spell Checker][vscode-cspell].
46
+ If you' re using VSCode, be sure to install the [Code Spell Checker][vscode-cspell]
47
+ extension.
44
48
45
- To run the checks manually (this is optional) you' ll need to:
49
+ To run the checks manually (this is optional, but encouraged if making
50
+ non-trivial changes) you' ll need to:
46
51
47
52
0. install [NodeJS & ` npm` ][install-node]
48
53
49
- 1. run ` npm test`
54
+ 1. run ` npm install` (to install the spellings libraries)
55
+
56
+ 1. run ` rake validate` to run all the checks
50
57
51
58
New spellings can be added to ` .spelling` . Be sure to spell added words correctly!
52
59
You can’t perform that action at this time.
0 commit comments