ci: add cspell spell-check for public documentation#48
Merged
ryderstorm merged 3 commits intomainfrom Mar 17, 2026
Merged
Conversation
Spots87
previously approved these changes
Mar 17, 2026
Add cspell pre-commit hook configuration and cspell.config.yaml with project-specific dictionary. Update CONTRIBUTING.md with cspell setup instructions for contributors.
Add instructions for running a local documentation preview server to README.md for contributor convenience.
ryderstorm
force-pushed
the
split/ci-tooling-and-project-docs
branch
from
46c9f04 to
2f6cbaa
Compare
Whitelist Tessl and BMAD in the comparison page cspell override so the documentation lint job passes for this branch. Co-Authored-By: OpenCode <no-reply@example.com>
Spots87
approved these changes
Mar 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
Adds automated spell-checking to the pre-commit pipeline so documentation typos are caught before merge.
What Changed?
.pre-commit-config.yamlcspell.config.yamlwith project dictionary and file patternsCONTRIBUTING.mdwith cspell setup instructionsREADME.mdwith local docs preview commandNotes
feat/add-pre-commit-for-cspellusing two-phase branch surgery