Add spellcheck workflow

[jjasghar]

We have a bunch of documentation, it wouldn't hurt to have spell check.

[bjhargrave]

I think you also need to include the configuration files.

[jjasghar]

It doesn't seem to unless we want to add a specific dictionary.

https://github.com/marketplace/actions/github-spellcheck-action#configuration

[lhawthorn]

LGTM

[bjhargrave]

Looking at the gha action, it requires a spellcheck.yml file which is not included in this PR.

For example: https://github.com/instructlab/instructlab/blob/main/.spellcheck.yml

I tested this PR in my fork and the spell check failed due to missing spellcheck.yml file.

Using pyspelling on configuration outlined in >spellcheck.yaml<
Checking files matching specified outlined in >spellcheck.yaml<
----------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/local/bin/pyspelling", line 8, in <module>
    sys.exit(main())
             ^^^^^^
  File "/usr/local/lib/python3.12/site-packages/pyspelling/__main__.py", line 30, in main
    return run(
           ^^^^
  File "/usr/local/lib/python3.12/site-packages/pyspelling/__main__.py", line 55, in run
    for results in spellcheck(
  File "/usr/local/lib/python3.12/site-packages/pyspelling/__init__.py", line 616, in spellcheck
    config = util.read_config(config_file)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/pyspelling/util/__init__.py", line 186, in read_config
    raise ValueError(
ValueError: Unable to find or load pyspelling configuration from spellcheck.yaml, for more details on configuration please read https://facelessuser.github.io/pyspelling/configuration/

[bjhargrave]

It doesn't seem to unless we want to add a specific dictionary.

https://github.com/marketplace/actions/github-spellcheck-action#configuration

Step 2 says you need to create a spellcheck.yml file.

[ckadner]

Nice!

[nathan-weinberg]

Very much in favor of this

[ckadner]

It doesn't seem to unless we want to add a specific dictionary.
https://github.com/marketplace/actions/github-spellcheck-action#configuration

Step 2 says you need to create a spellcheck.yml file.

https://github.com/instructlab/community/actions/runs/8835495973/job/24259773634?pr=162#step:4:19

  File "/usr/local/lib/python3.12/site-packages/pyspelling/__init__.py", line 616, in spellcheck
    config = util.read_config(config_file)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/pyspelling/util/__init__.py", line 186, in read_config
    raise ValueError(
ValueError: Unable to find or load pyspelling configuration from spellcheck.yaml, for more details on configuration please read https://facelessuser.github.io/pyspelling/configuration/
Error: Files in repository contain spelling errors

[bjhargrave]

Also, this PR needs to fix any spelling errors that may exist so that the repo passes the spellcheck action.

[lehors]

Ok, I've got to say it: I don't know why everybody seems to love those spellcheckers. In my experience they are a pain because there generate too many false positives. We're not producing literature and there are just too many terms we use that spellcheckers don't know, and about every PR needs to include its additions to the custom dictionary.
Now, feel free to ignore me, I've said my piece.

[nathan-weinberg]

Ok, I've got to say it: I don't know why everybody seems to love those spellcheckers. In my experience they are a pain because there generate too many false positives. We're not producing literature and there are just too many terms we use that spellcheckers don't know, and about every PR needs to include its additions to the custom dictionary. Now, feel free to ignore me, I've said my piece.

I think it makes a lot of sense given the doc-heavy nature of this repo, and I don't think the dictionary maintenence is going to be too hard once we get a lot of the base terms out of the way.

I've opened a PR for a Markdown Linter for this repo as well, they should pair well together: #218

[nathan-weinberg]

@ckadner can you take another look and approve/merge if things look good to you?

Edit: @ckadner is unavailable for a few days so we will proceed since his comments are addressed

Concerns have been address and reviewer is OOO