-
Notifications
You must be signed in to change notification settings - Fork 711
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
docs: configure spell check #539
Merged
Merged
Conversation
This file contains 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
sarahschwartz
added a commit
to FuelLabs/github-actions
that referenced
this pull request
Dec 7, 2023
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
Dentosal
previously approved these changes
Dec 11, 2023
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.
Some minor nits. You can fix those if it feels worth doing, but merging as-is is fine for me.
xgreenx
previously approved these changes
Dec 11, 2023
Dentosal
approved these changes
Dec 12, 2023
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
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
.