Skip to content
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 7 commits into from
Dec 12, 2023
Merged

docs: configure spell check #539

merged 7 commits into from
Dec 12, 2023

Conversation

sarahschwartz
Copy link
Contributor

@sarahschwartz sarahschwartz commented Dec 6, 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 "locking" 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 sarahschwartz self-assigned this Dec 6, 2023
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
@sarahschwartz sarahschwartz marked this pull request as ready for review December 7, 2023 21:43
@sarahschwartz sarahschwartz changed the title docs: add spell check docs: configure spell check Dec 7, 2023
Dentosal
Dentosal previously approved these changes Dec 11, 2023
Copy link
Member

@Dentosal Dentosal left a 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.

src/fuel-vm/index.md Outdated Show resolved Hide resolved
src/fuel-vm/instruction-set.md Outdated Show resolved Hide resolved
src/fuel-vm/instruction-set.md Show resolved Hide resolved
src/fuel-vm/instruction-set.md Show resolved Hide resolved
src/protocol/cryptographic-primitives.md Show resolved Hide resolved
xgreenx
xgreenx previously approved these changes Dec 11, 2023
src/fuel-vm/instruction-set.md Outdated Show resolved Hide resolved
@sarahschwartz sarahschwartz merged commit a44cacd into master Dec 12, 2023
6 checks passed
@sarahschwartz sarahschwartz deleted the sarah/spell-check branch December 12, 2023 22:02
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants