docs: configure spell check, minor improvements #5369
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
changed the title
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
sdankel
reviewed
Dec 8, 2023
Co-authored-by: Sophie Dankel <[email protected]>
xunilrj
reviewed
Dec 9, 2023
sdankel
previously approved these changes
Dec 13, 2023
|
There are conflicts with master now @sarahschwartz |
sdankel
previously approved these changes
Dec 19, 2023
xunilrj
approved these changes
Dec 19, 2023
sdankel
approved these changes
Dec 19, 2023
8 tasks
JoshuaBatty
added a commit
that referenced
this pull request
Aug 19, 2024
## Description I noticed that the command section for forc in the documentation was only showing headings and no information about the commands themselves. See below.  This was due to back ticks being placed around the heading in #5369. I've removed these ticks and added the commands to the list of accepted words. Also there were a lot of commands being missed due to their no longer being subcommands, this logic has been updated and all the forc commands are now being parsed. ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.locking" and add "ing" to the custom words list. Instead, rewrite the sentence as "locking with thelockmethod"..spellcheck.yml.