-
Notifications
You must be signed in to change notification settings - Fork 66
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.
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
docs: configure spell-check #1496
Conversation
This PR adds a spell-check to each docs workflow. You can see it tested here: Sway: FuelLabs/sway#5369 Fuelup: FuelLabs/fuelup#535 Specs: FuelLabs/fuel-specs#539 Fuels-rs: FuelLabs/fuels-rs#1224 Fuels-ts: FuelLabs/fuels-ts#1484 Wallet: FuelLabs/fuels-wallet#987 Indexer: FuelLabs/fuel-indexer#1496 GraphQL: FuelLabs/fuel-graphql-docs#25
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this! It's hard to catch them all when you're trying to cover everything. 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As always, thanks so much @sarahschwartz 🙏🏼
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work 👍
This PR configures the spell-check added to the docs workflow in the github-actions repo: FuelLabs/github-actions#23
The files checked are configured in
.spellcheck.yml
. This is also where you can configure what types of elements are ignored.Right now it ignores:
spell-check-custom-words.txt
(case sensitive, only exact match)Handling errors:
If the test fails:
spell-check-custom-words.txt
.lock
ing" and add "ing" to the custom words list. Instead, rewrite the sentence as "locking with thelock
method"..spellcheck.yml
.