Skip to content

Commit 0aea5d8

Browse files
committed
Expand the spellings section to cover all validation checks
1 parent 75c358e commit 0aea5d8

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,25 @@ using, which may present a security risk.
3535
When you've made a change, either push it to a forked repository, or to a
3636
feature branch, and [raise a pull request][raise-a-pr].
3737

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.
3942

4043
Spell checking is provided via [`cspell`][cspell], a library which integrates
4144
with a number of code editors. Checking is run automatically on pull requests.
4245

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.
4448
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:
4651

4752
0. install [NodeJS & `npm`][install-node]
4853

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
5057

5158
New spellings can be added to `.spelling`. Be sure to spell added words correctly!
5259

0 commit comments

Comments
 (0)