Skip to content

👷 Spellcheck the docs in CI and fix the typos it found - #101

Merged
kammce merged 1 commit into
mainfrom
spellcheck-ci
Oct 26, 2026
Merged

kammce merged 1 commit into
mainfrom
spellcheck-ci

Conversation

@kammce

@kammce kammce commented Oct 26, 2026

Copy link
Copy Markdown
Member

Adds a spellcheck to CI and fixes the typos it found.

CI

  • .pre-commit-config.yaml runs the cspell hook (cspell-cli v8.6.0, as in scatter_span) on every .md and .rst file.
  • The new 🔤 Spellcheck workflow runs it on pull requests, on pushes to main, and on manual runs.
  • Locally, pre-commit run --all-files runs the same check.

cspell.json

  • 129 new words, alphabetized after the existing 30:
    • technical terms, such as datasheet, baremetal, pimpl, semihosting, JTAG, NVIC and MISRA;
    • tool and library names, such as pyocd, picolibc, newlib and mkdocs;
    • people and company names, such as Rohde, Schwarz, Espressif and InvenSense.
  • Two ignore patterns: one for compiler flags such as -Osemihost_console_type, -Dbreathe_projects and -Tyour_linker_script.ld, and one for Conan cache paths, which contain package hashes.
  • reStructuredText checking is turned on alongside Markdown.

Typos fixed

Was Now Where
propogate, prevalant, offical, libaries, largets, implmentation, distibuting, choosen propagate, prevalent, official, libraries, largest, implementation, distributing, chosen contributor_guide/architecture.md
enviornement environment README.md
commnd command getting_started.md
featues features education/adc.md
AllThingsEmbeddd AllThingsEmbedded (the link text of that site) contributor_guide/arm/arm_cortex_m_bringup.md
SWDCLK, SWDCLCK SWCLK, the Arm pin name user_guide/debugging.md

Testing

  • cspell checks all 104 Markdown and reStructuredText files and finds no issues.
  • A probe file containing "recieve" fails the hook.

A pre-commit cspell hook checks every Markdown and reStructuredText file,
and a workflow runs it on pull requests and pushes to main. cspell.json
gains the technical words and names the docs use, plus patterns that skip
compiler flags and Conan cache paths.

@kammce kammce left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kammce
kammce merged commit 4855dea into main Oct 26, 2026
1 check passed
@kammce
kammce deleted the spellcheck-ci branch October 26, 2026 13:56
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.

1 participant