Skip to content

add spellchecker, some doc clean up #2

add spellchecker, some doc clean up

add spellchecker, some doc clean up #2

Workflow file for this run

name: 'Check spelling'
on: # rebuild any PRs and main branch changes
pull_request:
push:
jobs:
spellcheck: # run the action
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: streetsidesoftware/cspell-action@v5
with:
# eventually we intend to fail the build on spelling errors
# so we restrict this to the docs folder
root: './docs'
# only warn for now
inline: warning # error
strict: false # true fails the build
config: '.'