-
Notifications
You must be signed in to change notification settings - Fork 14
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: add spell-check #23
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
This was referenced Dec 7, 2023
cold-briu
approved these changes
Dec 7, 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.
Great job! 🚀
Thank you so much Sarah 🙏
sarahschwartz
added a commit
to FuelLabs/fuel-graphql-docs
that referenced
this pull request
Dec 7, 2023
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: - All code blocks that have a language (and will check code blocks that do not have a language) - Anything in between backticks - Words in `spell-check-custom-words.txt` (case sensitive, only exact match) - Numbers, even if they are attached to a word - Links in markdown link format #### Handling errors: If the test fails: - look up the word in the question to verify it is a real word and is correctly spelled - If it is a file name or is code, use backticks to ignore the word. - If it is a real word that is spelled correctly, or an acronym that is either common or is defined already, add it to `spell-check-custom-words.txt`. - If needed, rewrite the sentence. Ex: DON'T use "`lock`ing" and add "ing" to the custom words list. Instead, rewrite the sentence as "locking with the `lock` method". - If it otherwise should be ignored, you can configure the pipeline in `.spellcheck.yml`.
sarahschwartz
added a commit
to FuelLabs/fuels-rs
that referenced
this pull request
Dec 8, 2023
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: - All code blocks that have a language (and will check code blocks that do not have a language) - Anything in between backticks - Words in `spell-check-custom-words.txt` (case sensitive, only exact match) - Numbers, even if they are attached to a word - Links in markdown link format #### Handling errors: If the test fails: - look up the word in the question to verify it is a real word and is correctly spelled - If it is a file name or is code, use backticks to ignore the word. - If it is a real word that is spelled correctly, or an acronym that is either common or is defined already, add it to `spell-check-custom-words.txt`. - If needed, rewrite the sentence. Ex: DON'T use "`lock`ing" and add "ing" to the custom words list. Instead, rewrite the sentence as "locking with the `lock` method". - If it otherwise should be ignored, you can configure the pipeline in `.spellcheck.yml`.
sarahschwartz
added a commit
to FuelLabs/fuel-specs
that referenced
this pull request
Dec 12, 2023
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: - All code blocks that have a language (and will check code blocks that do not have a language) - Anything in between backticks - Words in `spell-check-custom-words.txt` (case sensitive, only exact match) - Numbers, even if they are attached to a word - Links in markdown link format #### Handling errors: If the test fails: - look up the word in the question to verify it is a real word and is correctly spelled - If it is a file name or is code, use backticks to ignore the word. - If it is a real word that is spelled correctly, or an acronym that is either common or is defined already, add it to `spell-check-custom-words.txt`. - If needed, rewrite the sentence. Ex: DON'T use "`lock`ing" and add "ing" to the custom words list. Instead, rewrite the sentence as "locking with the `lock` method". - If it otherwise should be ignored, you can configure the pipeline in `.spellcheck.yml`.
sarahschwartz
added a commit
to FuelLabs/sway
that referenced
this pull request
Dec 19, 2023
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: - All code blocks that have a language (and will check code blocks that do not have a language) - Anything in between backticks - Words in `spell-check-custom-words.txt` (case sensitive, only exact match) - Numbers, even if they are attached to a word - Links in markdown link format #### Handling errors: If the test fails: - look up the word in the question to verify it is a real word and is correctly spelled - If it is a file name or is code, use backticks to ignore the word. - If it is a real word that is spelled correctly, or an acronym that is either common or is defined already, add it to `spell-check-custom-words.txt`. - If needed, rewrite the sentence. Ex: DON'T use "`lock`ing" and add "ing" to the custom words list. Instead, rewrite the sentence as "locking with the `lock` method". - If it otherwise should be ignored, you can configure the pipeline in `.spellcheck.yml`. --------- Co-authored-by: Sophie Dankel <47993817+sdankel@users.noreply.github.com>
# 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 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