Remove some comments from updated spellcheck and move to documentation (

#32664) * Update spell.yml * Update index.md * Update index.md * Update index.md * Update .wordlist.txt * Restyled by prettier-markdown * Update index.md * Restyled by prettier-markdown * Update index.md * Update index.md * Update .wordlist.txt * Restyled by prettier-markdown --------- Co-authored-by: Restyled.io <commits@restyled.io>
project-chip · Jul 23, 2024 · 717f9c0 · 717f9c0
1 parent e496fca
commit 717f9c0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 10 deletions.
diff --git a/.github/workflows/spell.yml b/.github/workflows/spell.yml
@@ -25,16 +25,6 @@ on:
             - ".github/.wordlist.txt"
 
 jobs:
-#    Seems redundant; removed as pyspelling is customized while this is not
-#    check-reviewdog:
-#        name: Check Spelling - reviewdog
-#        runs-on: ubuntu-latest
-#        steps:
-#            - name: Checkout
-#              uses: actions/checkout@v4
-#            - uses: reviewdog/action-misspell@v1
-#              with:
-#                  github_token: ${{ secrets.GITHUB_TOKEN }}
     check-spellcheck:
         name: Check Spelling - pyspelling
         runs-on: ubuntu-latest

diff --git a/docs/ci-cd/index.md b/docs/ci-cd/index.md
@@ -35,5 +35,14 @@ Work In Progress
 ## Tools
 
 -   [Daily Fail Summary](tools/daily_fail_summary.md)
+-   Spellcheck
+    -   Uses
+        [`rojopolis`/spellcheck-github-actions](https://github.com/marketplace/actions/github-spellcheck-action#configuration),
+        a PySpelling-based spellchecker
+    -   This tool utilizes the definitions in .spellcheck.yml and
+        .github/`.wordlist.txt` to check all documentation files.
+        .spellcheck.yml defines the settings while `.wordlist.txt` is a
+        dictionary of words to skip checking (brand names, technical jargon,
+        acronyms)
 
 ## General Improvement Ideas