fix(docs): Add better messaging on how to add new words to the dictionary for spell-check

[tesseralis]

Description

• Add a yarn update-dictionary script to call scripts/update-dictionary.js for updating the dictionary with new words.
• Add a message at the end of yarn lint:docs with instructions for adding words:

Found linting errors in the docs. To add new words to the dictionary, run `yarn update-dictionary`.

Related Issues

Fixes: #25268

[marcysutton]

Thanks for adding this! It would be awesome to also add something to the contributing docs about running the script. Perhaps on the Docs Contributions page? Does the scope of the bot include any other content? https://www.gatsbyjs.org/contributing/docs-contributions/

[tesseralis]

@marcysutton the linter has a couple of grammar rules in addition to spell-checking. I think the best place to put it might be the [Gatsby Style Guide]? Add a foreword at the beginning like "we use remark to check formatting and retext to check several of the rules in this guide. [more info on how to run the linter and fix things]".

[muescha]

some words are should not go into the dictionary - they should be in code fences
this should also mentioned in the docs

[marcysutton]

Style Guide would work, and I agree adding a note about code fences would be necessary too.

[muescha]

here i would add a hint to check at first the code fences.

something like this (but it needs better wording):

At first check if these words are are variables, component names, 
function names, and packages, then you can put them in 
code fences (see section [Code formatting: Inline code](...)). 
Otherwise you can add the remaining words to the dictionary with the following command:

[muescha]

and also to check the brand names before checking, otherwise wrong spelled brand names get into the dictionary...

[gatsby-cloud-staging]

Your pull request can be previewed in Gatsby Cloud: https://build-76c0f1ce-06a5-4f79-87ae-666029736d8a.staging-previews.gtsb.io

[AishaBlake]

Thanks for making those changes, Nat! This is good as far as I'm concerned.