Skip to content

docs: fix spell check flags across wiki articles#504

Merged
taxmeifyoucan merged 1 commit into
eth-protocol-fellows:mainfrom
bourdillion:fix-typo-checks
Apr 22, 2026
Merged

docs: fix spell check flags across wiki articles#504
taxmeifyoucan merged 1 commit into
eth-protocol-fellows:mainfrom
bourdillion:fix-typo-checks

Conversation

@bourdillion
Copy link
Copy Markdown
Contributor

Adds missing terms to wordlist.txt to resolve spell check failures in:

  • post-quantum-cryptography.md
  • eof.md
  • engine-api.md

Also sorted the wordlist alphabetically and removed duplicates.

@github-actions
Copy link
Copy Markdown

Hi @bourdillion,

⚠️ Potential typos found in your pull request:

  • 📄 ./docs/wiki/research/history-expiry/history-expiry.md (line(s) 37,39):
    1. ❌ bitmask
  • 📄 ./docs/wiki/research/history-expiry/history-expiry.md (line(s) 37,39):
    1. ❌ bitmask

ℹ️ How to fix this error:

  1. If these are actual typos:

    • Open the files at the specified line numbers and fix them
  2. If these are names or one-off nouns:

    • Wrap them in <name> tags
    • Example: <name>Alex Pereira</name>
    • Use this for people's names or unique terms that appear rarely
  3. If these are valid terms:

    • Add them to wordlist.txt (one word per line)
    • Terms must be plain text without spaces/special chars
    • The list is case-insensitive
  4. If these are code terms:

    • Wrap them in backticks (`) in your markdown

ℹ️ Checking for typos locally

  1. Install aspell for your platform
  2. Navigate to project root and run:
for f in **/*.md ; do echo $f ; aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case --add-sgml-skip nospellcheck list < $f | sort | uniq -c ; done

Learn more about wordlist format

@taxmeifyoucan taxmeifyoucan merged commit 8b75341 into eth-protocol-fellows:main Apr 22, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants