Merge pull request #471 from argonne-lcf/felker-patch-1

Add details about CI tests

README.md

@@ -37,17 +37,22 @@ $ cd user-guides
 $ make install-dev
 ```
 
-### Preview the docs locally
+### Preview the docs locally and test for errors
 
-Run `mkdocs serve` or `make serve` to auto-build and serve the docs for preview in your web browser.
+Run `mkdocs serve` or `make serve` to auto-build and serve the docs for preview in your web browser:
 ```
 $ make serve
 ```
 
+GitHub Actions are used to automatically validate all changes in pull requests before they are merged, by executing `mkdocs build --strict`. The [`--strict`](https://www.mkdocs.org/user-guide/configuration/#validation) flag will print out warnings and return a nonzero code if any of a number of checks fail (e.g. broken relative links, orphaned Markdown pages thtat are missing from the navigation sidebar, etc.). To see if your changes will pass these tests, run the following command locally:
+```
+$ make build-docs
+```
+
 ### Working on documentation
 
 * All commits must have a commit message
-* Create your own branch from the `main` branch.  For this writing we are using `YOURBRANCH` as an example.
+* Create your own branch from the `main` branch.  For this writing we are using `YOURBRANCH` as an example:
 ```
 $ cd user-guides
 $ git fetch --all
@@ -56,7 +61,7 @@ $ git pull origin main
 $ git checkout -b YOURBRANCH
 $ git push -u origin YOURBRANCH
 ```
-* Commit your changes to the remote repo
+* Commit your changes to the remote repo:
 ```
 $ cd user-guides
 $ git status                         # check the status of the files you have editted