docs: configure spell-check (#1496)

* docs: add spell check, minor fixes

* edit

* use master for docs CI

.github/workflows/ci.yml

@@ -69,6 +69,7 @@ jobs:
     uses: FuelLabs/github-actions/.github/workflows/mdbook-docs.yml@master
     with:
       docs-src-path: docs/src
+      spellcheck-config-path: 'docs/.spellcheck.yml'
   mdbook-build:
     needs:
       - docs-test

docs/.spellcheck.yml

@@ -0,0 +1,30 @@
+matrix:
+    - name: SPCheck
+      aspell:
+        lang: en
+      dictionary:
+        encoding: utf-8
+        wordlists:
+          - docs/spell-check-custom-words.txt
+      pipeline:
+        - pyspelling.filters.context:
+            context_visible_first: true
+            escapes: \\[\\`~]
+            delimiters:
+            # Ignore all code blocks
+            - open: '(?s)^(?P<open> *`{3,}\s*(\w+\s*,?\s*)+.*?)$'
+              close: '^( *`{3,})$'
+        - pyspelling.filters.markdown:
+            markdown_extensions:
+              - pymdownx.superfences:
+        - pyspelling.filters.html:
+            comments: false
+            ignores:
+              - code
+              - pre
+      sources:
+        - 'docs/*.md'
+        - 'docs/src/*.md'
+        - 'docs/src/**/*.md'
+      default_encoding: utf-8
+

docs/CONTRIBUTING.md

@@ -6,7 +6,7 @@ Fuel Indexer has many dependent repositories. If you need any help or mentoring
 
 ## Code Standards
 
-- [ ] If you've added a new function, method, class or abstraction, please include rustdoc comments for the new code so others can better understand the change.
+- [ ] If you've added a new function, method, class or abstraction, please include `rustdoc` comments for the new code so others can better understand the change.
 - [ ] If your change is non-trivial and testable, please try to include at least one happy path test to ensure that your change works.
   - "Trivial" changes would be changes to docs, comments, or small style/syntactic changes
 
@@ -47,7 +47,7 @@ You can build Fuel Indexer:
 cargo build -p fuel-indexer -p fuel-indexer-api-server --release --locked
 ```
 
-Linting is done using rustfmt and clippy, which are each separate commands:
+Linting is done using `rustfmt` and `clippy`, which are each separate commands:
 
 ```sh
 cargo fmt --all --check
@@ -88,7 +88,7 @@ This is a rough outline of what a contributor's workflow looks like:
   - Examples:
     - If you fixed a bug, your message is `fix: database locking issue`
     - If you added new functionality, your message would be `enhancement: i added something super cool`
-    - If you just did a chore your message is: `chore: i did somthing not fun`
+    - If you just did a chore your message is: `chore: i helped do the chores`
   - Keeping commit messages short and consistent helps users parse release notes
 - Push up your branch to Github then (on the right hand side of the Github UI):
   - Assign yourself as the owner of the PR

docs/PULL_REQUEST_TEMPLATE.md

@@ -6,7 +6,7 @@ Thanks for opening a PR with the Fuel Indexer project. Please review the **Check
 - [ ] Please add proper labels.
 - [ ] If there is an issue associated with this PR, please link the issue (right-hand sidebar)
 - [ ] If there is not an issue associated with this PR, add this PR to the "Fuel Indexer" project (right-hand sidebar)
-- [ ] Please allow Codeowners at least 24 hours to do a first-pass review.
+- [ ] Please allow code owners at least 24 hours to do a first-pass review.
 - [ ] Please add thoroughly detailed testing steps below.
 - [ ] Please keep your Changelog message short and sweet.
 

docs/spell-check-custom-words.txt

@@ -0,0 +1,217 @@
+ABI
+ABIs
+ASM
+IDE
+IDEs
+LSP
+namespace
+ALU
+APIs
+JSON
+BrowserStack
+CLI
+Deserialization
+deserializing
+DApp
+subcurrency
+Subcurrency
+intrinsics
+Intrinsics
+workspace
+workspaces
+Workspaces
+neovim
+EVM
+EVM's
+EOA
+ERC
+Ethereum
+Ethereum's
+FVM
+FuelVM
+Fuelup
+Github
+GraphQL
+Infura
+JSON
+LSP
+Merkle
+PoA
+PoS
+PoW
+RPC
+SDK
+SDK's
+SDKs
+SauceLabs
+Sepolia
+Structs
+Sway
+TAI
+TODO
+TypeScript
+UTF
+UTXO
+UTXOs
+Utils
+VM
+VSCode
+abigen
+args
+async
+backend
+backtraces
+blockchain
+blockchain's
+bytecode
+codespace
+codespaces
+config
+cryptographic
+customizable
+customizations
+dapp
+dev
+dropdown
+enum
+enums
+env
+forc
+frontend
+fuelup
+fullstack
+graphQL
+graphql
+http
+https
+js
+localhost
+mainnet
+mempool
+merkle
+monorepo
+monorepos
+natively
+npm
+nvm
+onboarding
+params
+pnpm
+prerelease
+queryable
+quickstart
+relayer
+relayers
+repo
+repos
+runnable
+stateful
+struct
+structs
+struct's
+testnet
+testnets
+toolchain
+toolchains
+urql
+validator
+validators
+superABI
+superABIs
+SuperABIs
+supertraits
+compositional
+typeclass
+turbofish
+DSL
+TOML
+IPFS
+Bitwise
+Bitwise
+runtime
+runtimes
+formatter
+deployable
+Utils
+ETH
+initializer
+initializers
+destructuring
+instantiation
+VMs
+superset
+CEI
+pre
+entrancy
+interoperable
+blockchains
+keccak
+SHA
+UI
+backtrace
+Collateralized
+collateralized
+submodule
+DEX
+TypeChain
+inlines
+inlining
+MiB
+FuelVM's
+deterministically
+CLI
+VS
+GraphViz
+DOT
+DCA
+AST
+GitHub
+decrypt
+subcommand
+subcommands
+Subcommands
+supertrait
+supertraits
+Supertraits
+incrementor
+monomorphization
+Booleans
+boolean
+Orchestrator
+orchestrator
+growable
+arity
+tuple's
+unary
+SRC
+DEX
+FuelLabs
+PRs
+codebase
+PostgreSQL
+Postgres
+MacOS
+macOS
+backends
+hoc
+semver
+SQLx
+Homebrew
+Changelog
+lookups
+namespaces
+YAML
+WASM
+WebAssembly
+dApp
+dApps
+JWT
+Schemas
+schemas
+AssemblyScript
+indexable
+Macbook
+Dockerized
+TLDR
+IaaS
+Updatable

docs/src/SUMMARY.md

@@ -34,29 +34,29 @@
   - [Pagination](./querying/pagination.md)
   - [A Full Example](./querying/full-example.md)
 - [Authentication](./authentication/index.md)
-- [forc index](./forc-index/index.md)
-  - [auth](./forc-index/auth.md)
-  - [build](./forc-index/build.md)
-  - [check](./forc-index/check.md)
-  - [deploy](./forc-index/deploy.md)
-  - [kill](./forc-index/kill.md)
-  - [new](./forc-index/new.md)
-  - [remove](./forc-index/remove.md)
-  - [start](./forc-index/start.md)
-  - [status](./forc-index/status.md)
-- [forc postgres](./forc-postgres/index.md)
-  - [create](./forc-postgres/create.md)
-  - [drop](./forc-postgres/drop.md)
-  - [start](./forc-postgres/start.md)
-  - [stop](./forc-postgres/stop.md)
+- [`forc index`](./forc-index/index.md)
+  - [`auth`](./forc-index/auth.md)
+  - [`build`](./forc-index/build.md)
+  - [`check`](./forc-index/check.md)
+  - [`deploy`](./forc-index/deploy.md)
+  - [`kill`](./forc-index/kill.md)
+  - [`new`](./forc-index/new.md)
+  - [`remove`](./forc-index/remove.md)
+  - [`start`](./forc-index/start.md)
+  - [`status`](./forc-index/status.md)
+- [`forc postgres`](./forc-postgres/index.md)
+  - [`create`](./forc-postgres/create.md)
+  - [`drop`](./forc-postgres/drop.md)
+  - [`start`](./forc-postgres/start.md)
+  - [`stop`](./forc-postgres/stop.md)
 
 # For Contributors
 
 - [Environment Setup](./for-contributors/index.md)
 - [Contributing Standards](./for-contributors/contributing-standards.md)
 - [Release Schedule](./for-contributors/release-schedule.md)
 - [Building From Source](./for-contributors/building-from-source.md)
-- [System Dependencides](./for-contributors/system-dependencies.md)
+- [System Dependencies](./for-contributors/system-dependencies.md)
 
 # Appendix
 

docs/src/designing-a-schema/directives.md

@@ -46,7 +46,7 @@ type Library @entity {
 
 A `UNIQUE` constraint will be created on the `book` table's `name` column, ensuring that no books can share the same name.
 
-> Important: When using explict or implicit foreign keys, it is required that the reference column name in your foreign key relationship be unique. `ID` types are by default unique, but all other types will have to be explicitly specified as being unique via the `@unique` directive.
+> Important: When using explicit or implicit foreign keys, it is required that the reference column name in your foreign key relationship be unique. `ID` types are by default unique, but all other types will have to be explicitly specified as being unique via the `@unique` directive.
 
 ## `@join`
 

docs/src/designing-a-schema/relationships.md

@@ -4,7 +4,7 @@ The Fuel indexer service supports foreign key relationships and constraints. The
 
 > IMPORTANT:
 >
-> Implicit foreign keys do not require a `@join` directive. When using implicit foreign key references, merely add the referenced object as a field type (shown below). A lookup will automagically be done to add a foreign key constraint using this object's' `id` field.
+> Implicit foreign keys do not require a `@join` directive. When using implicit foreign key references, merely add the referenced object as a field type (shown below). A lookup will automatically be done to add a foreign key constraint using this object's' `id` field.
 >
 > Note that implicit foreign key relationships _only_ use the `id` field on the referenced table. If you plan to use implicit foreign keys, the object being referenced _must_ have an `id` field.
 >