Skip to content

Commit 657fa28

Browse files
Remove some comments from updated spellcheck and move to documentation (project-chip#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>
1 parent 4004d0b commit 657fa28

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

.github/workflows/spell.yml

-10
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,6 @@ on:
2525
- ".github/.wordlist.txt"
2626

2727
jobs:
28-
# Seems redundant; removed as pyspelling is customized while this is not
29-
# check-reviewdog:
30-
# name: Check Spelling - reviewdog
31-
# runs-on: ubuntu-latest
32-
# steps:
33-
# - name: Checkout
34-
# uses: actions/checkout@v4
35-
# - uses: reviewdog/action-misspell@v1
36-
# with:
37-
# github_token: ${{ secrets.GITHUB_TOKEN }}
3828
check-spellcheck:
3929
name: Check Spelling - pyspelling
4030
runs-on: ubuntu-latest

docs/ci-cd/index.md

+9
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,14 @@ Work In Progress
3535
## Tools
3636

3737
- [Daily Fail Summary](tools/daily_fail_summary.md)
38+
- Spellcheck
39+
- Uses
40+
[`rojopolis`/spellcheck-github-actions](https://github.com/marketplace/actions/github-spellcheck-action#configuration),
41+
a PySpelling-based spellchecker
42+
- This tool utilizes the definitions in .spellcheck.yml and
43+
.github/`.wordlist.txt` to check all documentation files.
44+
.spellcheck.yml defines the settings while `.wordlist.txt` is a
45+
dictionary of words to skip checking (brand names, technical jargon,
46+
acronyms)
3847

3948
## General Improvement Ideas

0 commit comments

Comments
 (0)