README.md: enhance README to make it clearer (#181) #211
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Document Scan | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - '**/*.md' | |
| pull_request: | |
| paths: | |
| - '**/*.md' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| scan_doc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: streetsidesoftware/cspell-action@v2 | |
| with: | |
| files: | | |
| **/*.md | |
| *.md | |
| config: .github/cspell.json | |
| verbose: true | |
| incremental_files_only: false |