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 #1484

Merged
merged 6 commits into from
Dec 10, 2023
Merged

docs: configure spell-check #1484

merged 6 commits into from
Dec 10, 2023

Conversation

sarahschwartz
Copy link
Contributor

@sarahschwartz sarahschwartz commented 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
  • All lines that start with <<<

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 7, 2023
Copy link
Contributor

github-actions bot commented Dec 7, 2023

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 86.54% 6025/6962
🟡 Branches 70.05% 933/1332
🟡 Functions 77.44% 992/1281
🟢 Lines 86.54% 5772/6670

Test suite run success

1465 tests passing in 258 suites.

Report generated by 🧪jest coverage report action from 35d87f9

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:45
@arboleya arboleya added the docs Requests pertinent to documentation label Dec 8, 2023
@Torres-ssf Torres-ssf merged commit 00bf7e1 into master Dec 10, 2023
10 checks passed
@Torres-ssf Torres-ssf deleted the sarah/spell-check branch December 10, 2023 16:06
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants