Skip to content

A local-first personal finance app

[AI] Replace archived check-spelling action with typos for docs spell-check (#8249)

Matiss Janis Aboltinse5747b2f2a3f
diff --git a/.claude/skills/writing-actual-docs/SKILL.md b/.claude/skills/writing-actual-docs/SKILL.md
index f49ce11e39..e1138caf9a 100644
--- a/.claude/skills/writing-actual-docs/SKILL.md
+++ b/.claude/skills/writing-actual-docs/SKILL.md
@@ -16,7 +16,7 @@ It is the authoritative source for front matter, heading rules, folder structure
1. Read `writing-docs.md` in full before drafting.
2. When the guide does not cover something, match the closest existing document in the same section rather than inventing a new pattern — site-wide consistency matters more than a marginally better local choice.
3. For new screenshots, follow both the placement rule (`/static/img/<section>/<doc-prefix>-...png`) and the annotation guidance from the guide. Annotate any screenshot showing more than one element the reader needs to distinguish.
-4. Before declaring the work done, sanity-check the file against the guide's structural rules: exactly one H1, Title Case headings, no time-bound phrasing, internal links written as relative file paths with the `.md` extension (not `/docs/...` URLs), images referenced from the correct path, and any new technical terms added to `.github/actions/docs-spelling/allow/keywords.txt` so the spell-check bot passes.
+4. Before declaring the work done, sanity-check the file against the guide's structural rules: exactly one H1, Title Case headings, no time-bound phrasing, internal links written as relative file paths with the `.md` extension (not `/docs/...` URLs), images referenced from the correct path, and — only if the `typos` spell-checker flags a term that is actually correct — that term allowed in `.github/actions/docs-spelling/typos.toml` so the spell-check passes.
## Why this matters
diff --git a/.github/actions/docs-spelling/README.md b/.github/actions/docs-spelling/README.md
index ef73ac266b..dd5655a625 100644
--- a/.github/actions/docs-spelling/README.md
+++ b/.github/actions/docs-spelling/README.md
@@ -1,17 +1,42 @@
-# check-spelling/check-spelling configuration
-
-| File | Purpose | Format | Info |
-| -------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| [dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary) |
-| [allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow) |
-| [reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject) |
-| [excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes) |
-| [only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only) |
-| [patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) |
-| [candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns) |
-| [line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) |
-| [expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) |
-| [advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice) |
-
-Note: you can replace any of these files with a directory by the same name (minus the suffix)
-and then include multiple files inside that directory (with that suffix) to merge multiple files together.
+# Docs spell-checking configuration
+
+The documentation under `packages/docs` is spell-checked by the
+[crate-ci/typos](https://github.com/crate-ci/typos) action, wired up in
+[`.github/workflows/docs-spelling.yml`](../../workflows/docs-spelling.yml).
+
+| File | Purpose |
+| ------------------------ | ----------------------------------------------------------------------------------- |
+| [typos.toml](typos.toml) | typos configuration: the allowlist of accepted words and the list of excluded files |
+
+## How it works
+
+typos only reports high-confidence misspellings from its built-in
+correction dictionary, so — unlike the previous check-spelling setup — proper
+nouns, bank codes, and abbreviations usually do **not** need to be added to an
+allowlist. Add an entry only when typos flags something that is actually
+correct.
+
+### Allowing a word
+
+Add it to `[default.extend-words]` in [typos.toml](typos.toml), mapped to
+itself:
+
+```toml
+[default.extend-words]
+HSA = "HSA"
+```
+
+### Excluding a file
+
+Add a glob to `extend-exclude` under `[files]` in [typos.toml](typos.toml).
+
+See the [typos documentation](https://github.com/crate-ci/typos/blob/master/docs/reference.md)
+for the full configuration reference.
+
+## Why not check-spelling?
+
+The repository previously used `check-spelling/check-spelling`. That project's
+upstream repository was archived and shipped a self-disabling "secpoll"
+kill-switch following a maintainer-account compromise on 2026-06-16, which made
+every workflow pinned to it fail fatally. typos is actively maintained and runs
+entirely from the checked-out tree without any PR-comment or bot machinery.
diff --git a/.github/actions/docs-spelling/advice.md b/.github/actions/docs-spelling/advice.md
deleted file mode 100644
index cf3b282997..0000000000
--- a/.github/actions/docs-spelling/advice.md
+++ /dev/null
@@ -1,24 +0,0 @@
-<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
-<details>
-<summary>If the flagged items are :exploding_head: false positives</summary>
-
-If items relate to a ...
-
-- binary file (or some other file you wouldn't want to check at all).
-
- Please add a file path to the `excludes.txt` file matching the containing file.
-
- File paths are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
-
- `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](../tree/HEAD/README.md) (on whichever branch you're using).
-
-- well-formed pattern.
-
- If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
- try adding it to the `patterns.txt` file.
-
- Patterns are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
-
- Note that patterns can't match multiline strings.
-
-</details>
diff --git a/.github/actions/docs-spelling/allow/contributers.txt b/.github/actions/docs-spelling/allow/contributers.txt
deleted file mode 100644
index 3a77e7ffa4..0000000000
--- a/.github/actions/docs-spelling/allow/contributers.txt
+++ /dev/null
@@ -1,8 +0,0 @@
-trevdor
-Farlow
-Matiss
-Aboltins
-jlongster
-howell
-evequefou
-Fiddaman
diff --git a/.github/actions/docs-spelling/allow/keywords.txt b/.github/actions/docs-spelling/allow/keywords.txt
deleted file mode 100644
index 2c1f592088..0000000000
--- a/.github/actions/docs-spelling/allow/keywords.txt
+++ /dev/null
@@ -1,155 +0,0 @@
-ABANCA
-actualbudget
-addtransactions
-Akahu
-AMZN
-Andelskassen
-AQL
-Authelia
-autocompletes
-Belarusian
-Blix
-bnp
-BSCHESMM
-BTC
-CAGLESMM
-Caju
-caniuse
-Cardless
-CAROOT
-categorygroup
-Cembra
-Certbot
-CLI
-clickable
-clsx
-codemirror
-Coinbase
-commandlet
-Coverflex
-Crd
-crdt
-creditcards
-crowdsourced
-debian
-dedupes
-deleteaccount
-DKB
-DKK
-dmg
-easybank
-Edenred
-Coverfelx
-emojis
-emoji
-escodegen
-EUR
-expando
-Firefox
-flyctl
-Formik
-Fortuneo
-gebabebb
-GEBABEBB
-Greenshot
-GTQ
-HSA
-htpasswd
-IBANs
-IDR
-iex
-importtransactions
-ING
-invokable
-iwr
-jointaccounts
-jwl
-KBC
-kcab
-keyout
-KREDBEBB
-Kroger
-kubectl
-kubernetes
-ldaplogin
-letsencrypt
-libofx
-linting
-Linuxes
-linuxsvg
-lleskassen
-lte
-mac
-macsvg
-Mariushosting
-minimalistic
-monkeypatch
-Monobank
-Morrisons
-MYR
-NAIAGB
-NDEADKKK
-Netflix
-netlify
-Nordea
-NORDEA
-nordigen
-notlike
-NRNBGB
-nynab
-offbudget
-ofx
-OFX
-oneof
-oxfmt
-oxlint
-payeerule
-pikaday
-pikapods
-playsinline
-portalization
-Postgresql
-protobuf
-publix
-pwa
-PWA
-QFX
-QIF
-Quicken
-returnsandreimbursements
-responsitivity
-Rezip
-roadmap
-RUpdate
-sankey
-SANTANDER
-screenshots
-SEB
-subfolders
-subreaper
-subtransaction
-subtransactions
-Suisse
-Sztup
-tini
-traefik
-Trafico
-Trumf
-Upstash
-useb
-usernames
-valign
-vfile
-Venmo
-Weblate
-winsvg
-WSL
-Xxxxx
-ynab
-Ynab
-YNAB
-ZKB
-Zsolt
-IDBy
-isapprox
-isbetween
diff --git a/.github/actions/docs-spelling/excludes.txt b/.github/actions/docs-spelling/excludes.txt
deleted file mode 100644
index 42d8ea4163..0000000000
--- a/.github/actions/docs-spelling/excludes.txt
+++ /dev/null
@@ -1,77 +0,0 @@
-# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
-(?:^|/)(?i).nojekyll
-(?:^|/)(?i)COPYRIGHT
-(?:^|/)(?i)docusaurus.config.js
-(?:^|/)(?i)LICEN[CS]E
-(?:^|/)(?i)README.md
-(?:^|/)3rdparty/
-(?:^|/)go\.sum$
-(?:^|/)package(?:-lock|)\.json$
-(?:^|/)pyproject.toml
-(?:^|/)requirements(?:-dev|-doc|-test|)\.txt$
-(?:^|/)vendor/
-(?:^|/)yarn\.lock$
-\.a$
-\.ai$
-\.avi$
-\.bmp$
-\.bz2$
-\.class$
-\.coveragerc$
-\.crt$
-\.css$
-\.dll$
-\.docx?$
-\.drawio$
-\.DS_Store$
-\.eot$
-\.exe$
-\.gif$
-\.git-blame-ignore-revs$
-\.gitattributes$
-\.graffle$
-\.gz$
-\.icns$
-\.ico$
-\.jar$
-\.jks$
-\.jpe?g$
-\.key$
-\.lib$
-\.lock$
-\.map$
-\.min\..
-\.mod$
-\.mp[34]$
-\.o$
-\.ocf$
-\.otf$
-\.pdf$
-\.pem$
-\.png$
-\.psd$
-\.pyc$
-\.pylintrc$
-\.s$
-\.svgz?$
-\.tar$
-\.tiff?$
-\.tsx$
-\.ttf$
-\.wav$
-\.webm$
-\.webp$
-\.woff2?$
-\.xlsx?$
-\.zip$
-^\.github/actions/spelling/
-^\.github/ISSUE_TEMPLATE/
-^\.yarn/
-^\Q.github/\E$
-^\Q.github/workflows/spelling.yml\E$
-^\Qnode_modules/\E$
-^\Qsrc/\E$
-^\Qstatic/\E$
-^\static/
-^packages/docs/docs/releases\.md$
-ignore$
diff --git a/.github/actions/docs-spelling/expect.txt b/.github/actions/docs-spelling/expect.txt
deleted file mode 100644
index b0aea401cf..0000000000
--- a/.github/actions/docs-spelling/expect.txt
+++ /dev/null
@@ -1,217 +0,0 @@
-Abanca
-ABNAMRO
-ABNANL
-Activo
-actualrc
-admins
-AESUDEF
-ajv
-ALZEY
-amd
-Anglais
-ANZ
-aql
-AUR
-Authentik
-autogen
-AVERAGEA
-BANKA
-BANKINTER
-BAWAATWW
-Belfius
-Biedenkopf
-BIGBPLPW
-Bizum
-BKBKESMM
-BOFIIE
-Bourso
-Boursobank
-Boursorama
-BPER
-BPMOIT
-brexplpw
-BYLADEM
-Caddyfile
-CAGLPTPL
-Caixa
-CAMT
-cashflow
-Catppuccin
-Cetelem
-cimode
-Citi
-Citibank
-claude
-Cloudflare
-CLP
-CMCIFRPAXXX
-COBADEFF
-CODEOWNERS
-Codespaces
-COEP
-commerzbank
-Copiar
-COUNTA
-COUNTBLANK
-countif
-CREGBEBB
-crt
-CZK
-Danske
-datadir
-datamodel
-DATEDIF
-Depositos
-deselection
-DIREKT
-Dockerfiles
-Dominguez
-DUSSDEDDXXX
-DUSSELDORF
-EDATE
-ENTERCARD
-Entra
-EOMONTH
-EUA
-Eurocard
-fidd
-Fineco
-Finicity
-Fintro
-Finverse
-Flathub
-FORTUNEO
-FTNOFRP
-Gemeinschaftsbank
-Geral
-gernes
-Globecard
-GLS
-gocardless
-Grafana
-Gruvbox
-HABAL
-Hampel
-healthcheck
-HELADEF
-HLOOKUP
-HUF
-IFERROR
-IFNA
-Ilavenil
-INDUSTRIEL
-INGBPLPW
-Ingo
-INR
-Intesa
-INVSTMTMSGSRS
-IRR
-ISERROR
-ISEVEN
-ISLOGICAL
-ISNA
-ISODD
-ISOWEEKNUM
-ISTEXT
-ISYBANK
-ITBBITMM
-jfdoming
-JMD
-jws
-KBCBE
-Keycloak
-Khurozov
-KORT
-Kreditbank
-lage
-LHV
-LHVBEE
-LKR
-lookback
-MAXA
-mbank
-mdc
-metainfo
-modals
-Moldovan
-murmurhash
-NETWORKDAYS
-nginx
-nodenext
-nord
-OIDC
-Okabe
-overbudgeted
-overbudgeting
-overfunded
-oxc
-Paribas
-passwordless
-PAYPAL
-picomatch
-pluggyai
-Poste
-PPABPLPK
-prefs
-proactively
-Qatari
-QNTOFRP
-QONTO
-Raiffeisen
-REGEXREPLACE
-relinking
-revolut
-RIED
-RSchedule
-RSD
-SEK
-shopt
-simplefin
-SKHSFI
-Sparkasse
-SPK
-sseldorf
-SSK
-Stadtsparkasse
-statestore
-STDEVP
-SUBASKBX
-sumif
-SUMPRODUCT
-SUMSQ
-SVGR
-swc
-SWEDBANK
-SWEDNOKK
-Synology
-systemctl
-taskbar
-templating
-THB
-TIMEFRAME
-touchscreen
-triaging
-trustedauthproxies
-tsgo
-tsgolint
-TWD
-UAH
-ubuntu
-undici
-Unmigrate
-userinfo
-Userscripts
-UZS
-VLOOKUP
-vrt
-VUB
-Wallos
-websecure
-WEEKNUM
-Widiba
-WOR
-worktree
-youngcw
-zizmor
-FORMATCURRENCY
-FORMATNUMBER
diff --git a/.github/actions/docs-spelling/line_forbidden.patterns b/.github/actions/docs-spelling/line_forbidden.patterns
deleted file mode 100644
index cd1799f26a..0000000000
--- a/.github/actions/docs-spelling/line_forbidden.patterns
+++ /dev/null
@@ -1,62 +0,0 @@
-# reject `m_data` as there's a certain OS which has evil defines that break things if it's used elsewhere
-# \bm_data\b
-
-# If you have a framework that uses `it()` for testing and `fit()` for debugging a specific test,
-# you might not want to check in code where you were debugging w/ `fit()`, in which case, you might want
-# to use this:
-#\bfit\(
-
-# s.b. GitHub
-#\bGithub\b
-
-# s.b. GitLab
-\bGitlab\b
-
-# s.b. JavaScript
-\bJavascript\b
-
-# s.b. Microsoft
-\bMicroSoft\b
-
-# s.b. another
-\ban[- ]other\b
-
-# s.b. greater than
-\bgreater then\b
-
-# s.b. into
-#\sin to\s
-
-# s.b. opt-in
-\sopt in\s
-
-# s.b. less than
-\bless then\b
-
-# s.b. otherwise
-\bother[- ]wise\b
-
-# s.b. nonexistent
-\bnon existing\b
-\b[Nn]o[nt][- ]existent\b
-
-# s.b. preexisting
-[Pp]re[- ]existing
-
-# s.b. preempt
-[Pp]re[- ]empt\b
-
-# s.b. preemptively
-[Pp]re[- ]emptively
-
-# s.b. reentrancy
-[Rr]e[- ]entrancy
-
-# s.b. reentrant
-[Rr]e[- ]entrant
-
-# s.b. workaround(s)
-\bwork[- ]arounds?\b
-
-# Reject duplicate words
-\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s
diff --git a/.github/actions/docs-spelling/only.txt b/.github/actions/docs-spelling/only.txt
deleted file mode 100644
index 4c33031cda..0000000000
--- a/.github/actions/docs-spelling/only.txt
+++ /dev/null
@@ -1,3 +0,0 @@
-# Only check files in the packages/docs directory
-^packages/docs/
-
diff --git a/.github/actions/docs-spelling/patterns.txt b/.github/actions/docs-spelling/patterns.txt
deleted file mode 100644
index 3b7f96cb59..0000000000
--- a/.github/actions/docs-spelling/patterns.txt
+++ /dev/null
@@ -1,84 +0,0 @@
-# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns
-
-# Questionably acceptable forms of `in to`
-# Personally, I prefer `log into`, but people object
-# https://www.tprteaching.com/log-into-log-in-to-login/
-\b[Ll]og in to\b
-
-# acceptable duplicates
-# ls directory listings
-[-bcdlpsw](?:[-r][-w][-Ssx]){3}\s+\d+\s+\S+\s+\S+\s+\d+\s+
-# C types and repeated CSS values
-\s(center|div|inherit|long|LONG|none|normal|solid|thin|transparent|very)(?: \g{-1})+\s
-# go templates
-\s(\w+)\s+\g{-1}\s+\`(?:graphql|json|yaml):
-# javadoc / .net
-(?:[\\@](?:groupname|param)|(?:public|private)(?:\s+static|\s+readonly)*)\s+(\w+)\s+\g{-1}\s
-
-# Commit message -- Signed-off-by and friends
-^\s*(?:(?:Based-on-patch|Co-authored|Helped|Mentored|Reported|Reviewed|Signed-off)-by|Thanks-to): (?:[^<]*<[^>]*>|[^<]*)\s*$
-
-# Autogenerated revert commit message
-^This reverts commit [0-9a-f]{40}\.$
-
-# ignore long runs of a single character:
-\b([A-Za-z])\g{-1}{3,}\b
-
-# Automatically suggested patterns
-# hit-count: 1255 file-count: 51
-# https/http/file urls
-(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]
-
-# hit-count: 1174 file-count: 33
-# GitHub SHAs (markdown)
-(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)
-
-# hit-count: 6 file-count: 4
-# version suffix <word>v#
-(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))
-
-# hit-count: 6 file-count: 2
-# URL escaped characters
-\%[0-9A-F][A-F]
-
-# hit-count: 5 file-count: 4
-# hex runs
-\b[0-9a-fA-F]{16,}\b
-
-# hit-count: 4 file-count: 2
-# uuid:
-\b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b
-
-# hit-count: 3 file-count: 2
-# discord
-/discord(?:app\.com|\.gg)/(?:invite/)?[a-zA-Z0-9]{7,}
-
-# hit-count: 2 file-count: 2
-# Contributor
-\[[^\]]+\]\(https://github\.com/[^/\s"]+\)
-@[^$\W]*-?\w+
-
-# hit-count: 1 file-count: 1
-# While you could try to match `http://` and `https://` by using `s?` in `https?://`, sometimes there
-# YouTube url
-\b(?:(?:www\.|)youtube\.com|youtu.be)/(?:channel/|embed/|user/|playlist\?list=|watch\?v=|v/|)[-a-zA-Z0-9?&=_%]*
-
-# hit-count: 1 file-count: 1
-# Google Fonts
-\bfonts\.(?:googleapis|gstatic)\.com/[-/?=:;+&0-9a-zA-Z]*
-
-# hit-count: 1 file-count: 1
-# hex digits including css/html color classes:
-(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|u\d+)\b
-
-# docusaurus image paths, URLs
-[-a-zA-Z0-9@:%_\+.~#?&//=]{2,256}\.[a-z]{2,4}\b(\/[-a-zA-Z0-9@:%_\+.~#?&//=]*)?
-
-# eliminate words like [`nvm`] or [`asdf`] or [heidiSQL] without backquotes
-\[.+?]
-
-# allowlist specific non-English words with non-ASCII characters
-\b(Länsförsäkringar|München|Złoty)\b
-
-# allowlist specific proper nouns
-\b(CodeRabbit)\b
diff --git a/.github/actions/docs-spelling/reject.txt b/.github/actions/docs-spelling/reject.txt
deleted file mode 100644
index b5a6d36809..0000000000
--- a/.github/actions/docs-spelling/reject.txt
+++ /dev/null
@@ -1,10 +0,0 @@
-^attache$
-benefitting
-occurences?
-^dependan.*
-^oer$
-Sorce
-^[Ss]pae.*
-^untill$
-^untilling$
-^wether.*
diff --git a/.github/actions/docs-spelling/typos.toml b/.github/actions/docs-spelling/typos.toml
new file mode 100644
index 0000000000..5ed650508b
--- /dev/null
+++ b/.github/actions/docs-spelling/typos.toml
@@ -0,0 +1,41 @@
+# Configuration for `crate-ci/typos`, used by the "Check Spelling (Docs)"
+# workflow (.github/workflows/docs-spelling.yml) to spell-check the
+# documentation under packages/docs.
+#
+# Unlike the previous check-spelling action, typos only reports
+# high-confidence misspellings (drawn from its built-in correction
+# dictionary) rather than every unknown word, so proper nouns, bank codes,
+# and abbreviations generally do not need an allowlist entry. Only words
+# that typos *incorrectly* flags need to be listed below.
+
+[files]
+extend-exclude = [
+ # Aggregated, auto-generated release notes. These mirror the upstream
+ # GitHub release notes verbatim (contributor handles, PR titles, and any
+ # historical typos baked into them), so they are not spell-checked.
+ "releases.md",
+ "*-release-*.md",
+ # Binary / non-prose assets.
+ "*.webp",
+ "*.png",
+ "*.jpg",
+ "*.jpeg",
+ "*.gif",
+ "*.svg",
+ "*.ico",
+ "*.pdf",
+ # Lockfiles and generated data.
+ "*.lock",
+ "package-lock.json",
+]
+
+# Words typos flags by default but that are valid here. Each is mapped to
+# itself, which tells typos to accept it.
+[default.extend-words]
+# Health Savings Account.
+HSA = "HSA"
+# The monorepo task runner (https://microsoft.github.io/lage/).
+Lage = "Lage"
+lage = "lage"
+# Hex color component (e.g. "FB BA 00" in the theming docs).
+BA = "BA"
diff --git a/.github/workflows/docs-spelling.yml b/.github/workflows/docs-spelling.yml
index f2da783e8f..533cf01732 100644
--- a/.github/workflows/docs-spelling.yml
+++ b/.github/workflows/docs-spelling.yml
@@ -1,37 +1,16 @@
name: Check Spelling (Docs)
-# Comment management is handled through a secondary job, for details see:
-# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions
+# Spell-checks the documentation under packages/docs using crate-ci/typos.
#
-# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment
-# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare)
-# it needs `contents: write` in order to add a comment.
+# This replaces the previous check-spelling/check-spelling action, whose
+# upstream repository was archived and shipped a self-disabling "secpoll"
+# kill-switch after a maintainer-account compromise (2026-06-16). typos is
+# actively maintained, runs entirely from the checked-out tree, and needs
+# no PR-comment or bot-apply machinery, so the workflow only requires
+# read access to the repository contents.
#
-# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment
-# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment)
-# it needs `pull-requests: write` in order to manipulate those comments.
-
-# Updating pull request branches is managed via comment handling.
-# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list
-#
-# These elements work together to make it happen:
-#
-# `on.issue_comment`
-# This event listens to comments by users asking to update the metadata.
-#
-# `jobs.update`
-# This job runs in response to an issue_comment and will push a new commit
-# to update the spelling metadata.
-#
-# `with.experimental_apply_changes_via_bot`
-# Tells the action to support and generate messages that enable it
-# to make a commit to update the spelling metadata.
-#
-# `with.ssh_key`
-# In order to trigger workflows when the commit is made, you can provide a
-# secret (typically, a write-enabled github deploy key).
-#
-# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key
+# Configuration (allowlist, excluded files) lives in
+# .github/actions/docs-spelling/typos.toml.
on:
push:
@@ -43,15 +22,7 @@ on:
- 'packages/docs/**'
- '.github/workflows/docs-spelling.yml'
- '.github/actions/docs-spelling/**'
- # Required by the upstream check-spelling action's documented
- # restricted-permissions pattern. Comment work is split into
- # separately permissioned jobs (see header) so the spelling job
- # itself does not write anything PR-controlled.
- pull_request_target: # zizmor: ignore[dangerous-triggers]
- branches:
- - '**'
- tags-ignore:
- - '**'
+ pull_request:
paths:
- 'packages/docs/**'
- '.github/workflows/docs-spelling.yml'
@@ -60,110 +31,25 @@ on:
- 'opened'
- 'reopened'
- 'synchronize'
- issue_comment:
- types:
- - 'created'
+
+permissions:
+ contents: read
jobs:
spelling:
name: Check Spelling
- permissions:
- contents: read
- pull-requests: read
- actions: read
- security-events: write
- outputs:
- followup: ${{ steps.spelling.outputs.followup }}
runs-on: depot-ubuntu-latest
- if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'"
concurrency:
group: spelling-${{ github.event.pull_request.number || github.ref }}
- # note: If you use only_check_changed_files, you do not want cancel-in-progress
cancel-in-progress: true
steps:
- - name: check-spelling
- id: spelling
- uses: check-spelling/check-spelling@cfb6f7e75bbfc89c71eaa30366d0c166f1bd9c8c # main
+ - name: Checkout
+ uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
- suppress_push_for_open_pull_request: 1
- checkout: true
- check_file_names: 1
- spell_check_this: check-spelling/spell-check-this@92453f59cac8985482dfc301a8ece4c6d7de8a0c # prerelease
- post_comment: 0
- use_magic_file: 1
- experimental_apply_changes_via_bot: 1
- use_sarif: 1
- extra_dictionary_limit: 12
- check_extra_dictionaries: ''
- extra_dictionaries: cspell:cpp/src/cpp.txt
- cspell:software-terms/src/software-terms.txt
- cspell:python/src/python/python-lib.txt
- cspell:node/node.txt
- cspell:filetypes/filetypes.txt
- cspell:aws/aws.txt
- cspell:typescript/dict/typescript.txt
- cspell:npm/dict/npm.txt
- cspell:fullstack/dict/fullstack.txt
- cspell:html/dict/html.txt
- cspell:css/dict/css.txt
- config: .github/actions/docs-spelling
-
- comment-push:
- name: Report (Push)
- # If your workflow isn't running on push, you can remove this job
- runs-on: depot-ubuntu-latest
- needs: spelling
- permissions:
- contents: write
- if: (success() || failure()) && needs.spelling.outputs.followup && github.event_name == 'push'
- steps:
- - name: comment
- uses: check-spelling/check-spelling@cfb6f7e75bbfc89c71eaa30366d0c166f1bd9c8c # main
- with:
- checkout: true
- spell_check_this: check-spelling/spell-check-this@92453f59cac8985482dfc301a8ece4c6d7de8a0c # prerelease
- task: ${{ needs.spelling.outputs.followup }}
- config: .github/actions/docs-spelling
-
- comment-pr:
- name: Report (PR)
- # If you workflow isn't running on pull_request*, you can remove this job
- runs-on: depot-ubuntu-latest
- needs: spelling
- permissions:
- pull-requests: write
- if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request')
- steps:
- - name: comment
- uses: check-spelling/check-spelling@cfb6f7e75bbfc89c71eaa30366d0c166f1bd9c8c # main
- with:
- checkout: true
- spell_check_this: check-spelling/spell-check-this@92453f59cac8985482dfc301a8ece4c6d7de8a0c # prerelease
- task: ${{ needs.spelling.outputs.followup }}
- experimental_apply_changes_via_bot: 1
- config: .github/actions/docs-spelling
-
- update:
- name: Update PR
- permissions:
- contents: write
- pull-requests: write
- actions: read
- runs-on: depot-ubuntu-latest
- environment: docs-spelling
- if: ${{
- github.event_name == 'issue_comment' &&
- github.event.issue.pull_request &&
- contains(github.event.comment.body, '@check-spelling-bot apply')
- }}
- concurrency:
- group: spelling-update-${{ github.event.issue.number }}
- cancel-in-progress: false
- steps:
- - name: apply spelling updates
- uses: check-spelling/check-spelling@cfb6f7e75bbfc89c71eaa30366d0c166f1bd9c8c # main
+ # Read-only spell-check job; no authenticated git operations needed.
+ persist-credentials: false
+ - name: Spell check docs
+ uses: crate-ci/typos@8951ef9cb569c860bc8f3f18070fbfaf65cdb349 # v1.30.0
with:
- experimental_apply_changes_via_bot: 1
- checkout: true
- ssh_key: '${{ secrets.CHECK_SPELLING }}'
- config: .github/actions/docs-spelling
+ files: ./packages/docs
+ config: .github/actions/docs-spelling/typos.toml
diff --git a/packages/docs/docs/budgeting/credit-cards/paying-in-full.md b/packages/docs/docs/budgeting/credit-cards/paying-in-full.md
index 114ff9f35a..78057f1ca0 100644
--- a/packages/docs/docs/budgeting/credit-cards/paying-in-full.md
+++ b/packages/docs/docs/budgeting/credit-cards/paying-in-full.md
@@ -36,7 +36,7 @@ See [Carrying Debt](./carrying-debt.md) for instructions on how we set up our ac
:::
-We'll need the following informaiton from our July statement:
+We'll need the following information from our July statement:
**Chase Account Summary - July 2025**
diff --git a/packages/docs/docs/contributing/writing-docs.md b/packages/docs/docs/contributing/writing-docs.md
index d69b30b397..6ddd7ef4f3 100644
--- a/packages/docs/docs/contributing/writing-docs.md
+++ b/packages/docs/docs/contributing/writing-docs.md
@@ -259,12 +259,10 @@ Place the content inside the details-tags.
## How To Fix Spelling Errors
-As part of the build process, GitHub actions runs a spell checker bot on the documentation. If the bot finds any spelling error, it will be reported in the build output on GitHub. You must fix this by editing the file and correcting the spelling error.
+As part of the build process, GitHub Actions runs a spell checker ([typos](https://github.com/crate-ci/typos)) on the documentation. If it finds any spelling error, it will be reported in the build output on GitHub. You must fix this by editing the file and correcting the spelling error.
-![Image of spelling bot error](/img/repo/spellingbot-example.webp)
-
-If the bot mistakes a word, you can add it to the `/.github/actions/docs-spelling/allow/keywords.txt` file.
-This will prevent the bot from reporting this word as a spelling error in the future.
+If the checker mistakes a word, you can allow it by adding it to the `[default.extend-words]` section of `/.github/actions/docs-spelling/typos.toml`, mapped to itself (for example `HSA = "HSA"`).
+This will prevent it from being reported as a spelling error in the future.
## Naming Standards
diff --git a/packages/docs/docs/schedules.md b/packages/docs/docs/schedules.md
index 80b2a71fed..4c20e6e46b 100644
--- a/packages/docs/docs/schedules.md
+++ b/packages/docs/docs/schedules.md
@@ -52,7 +52,7 @@ This flexibility allows you to customize your view — whether you want to see a
Changing the upcoming length only affects how schedules are displayed in your ledger; it does not impact how your budget data is stored or calculated. You can adjust this setting at any time to fit your preferences. If we change the upcoming length to _1 month_ the Account register will also reflect this change:
-![Accont Register View with future schedules](/img/schedules/schedules-account-register.webp)
+![Account Register View with future schedules](/img/schedules/schedules-account-register.webp)
## Creating a Schedule
@@ -75,7 +75,7 @@ Since a mortgage payment is a recurring transaction, the **Repeats** checkbox sh
You can also enter more than one date by hitting the **+** button next to the date field.
This is useful for transactions that occur on multiple days of the month, such as a bi-weekly payments.
-![Example of changing the frequencey of a schedule](/img/schedules/schedules-add-repeat.webp)
+![Example of changing the frequency of a schedule](/img/schedules/schedules-add-repeat.webp)
The **Move schedule** checkbox allows you to move the schedule either before or after a weekend, if the selected date falls on a weekend.
@@ -122,7 +122,7 @@ Navigate to the Accounts page, find the transaction you wish to create a schedul
2. Once selected, go to the drop-down menu on the top right of the page.
3. Click on **Link schedule**.
-![Example of transaction overivew](/img/schedules/schedules-from-transactions.webp)
+![Example of transaction overview](/img/schedules/schedules-from-transactions.webp)
In the Pop up that appears click "Create New"
@@ -163,7 +163,7 @@ Many times it's desired to add notes to the scheduled transactions or to assign
When you edit a schedule, the **Edit as rule** button will appear in the dialog
-![Example of editing a scheudle](/img/schedules/schedules-edit-as-rule.webp)
+![Example of editing a schedule](/img/schedules/schedules-edit-as-rule.webp)
Click on **Edit as Rule** to further customize the automatic entry.
diff --git a/upcoming-release-notes/8249.md b/upcoming-release-notes/8249.md
new file mode 100644
index 0000000000..16f1b42731
--- /dev/null
+++ b/upcoming-release-notes/8249.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [MatissJanis]
+---
+
+Replace the archived check-spelling docs CI action with crate-ci/typos