Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove some comments from updated spellcheck and move to documentation #32664

Merged
merged 13 commits into from
Mar 26, 2024
+9 −10
Merged

Remove some comments from updated spellcheck and move to documentation #32664

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d38f49d
Update spell.yml
kliao-csa Mar 21, 2024
92ea4b7
Update index.md
kliao-csa Mar 21, 2024
8b961f4
Update index.md
kliao-csa Mar 21, 2024
3d3d9ad
Update index.md
kliao-csa Mar 21, 2024
d05892a
Update .wordlist.txt
kliao-csa Mar 21, 2024
9b2c0ee
Restyled by prettier-markdown
restyled-commits Mar 21, 2024
5bfe98d
Update index.md
kliao-csa Mar 21, 2024
b37b2c9
Restyled by prettier-markdown
restyled-commits Mar 21, 2024
a9cb25e
Update index.md
kliao-csa Mar 21, 2024
ff2c467
Update index.md
kliao-csa Mar 22, 2024
8034fd0
Update .wordlist.txt
kliao-csa Mar 22, 2024
010f147
Restyled by prettier-markdown
restyled-commits Mar 22, 2024
7ddc163
Merge branch 'master' into spellcheck-comment
kliao-csa Mar 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/.wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1179,6 +1179,7 @@ responder
RestrictedEvent
retargeting
reusability
reviewdog
kliao-csa marked this conversation as resolved.
Show resolved Hide resolved
reviwed
rfid
rfids
Expand All @@ -1187,6 +1188,7 @@ riscv
rloc
rmw
rodata
rojopolis
kliao-csa marked this conversation as resolved.
Show resolved Hide resolved
Rollershade
rootfs
RPC
Expand Down Expand Up @@ -1535,6 +1537,7 @@ WindowCoveringGoToLiftPercentage
WiseMCU
wlan
wmm
wordlist
WPA
wpan
wra
Expand Down
10 changes: 0 additions & 10 deletions .github/workflows/spell.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/ci-cd/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,13 @@ 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 .worklist.txt is a dictionary of words to
kliao-csa marked this conversation as resolved.
Show resolved Hide resolved
skip checking (brand names, technical jargon, acronyms)

## General Improvement Ideas
Loading