Add codespell integration for spell checking

[Jooho]

• Add codespell tool setup: Added codespell configuration in Makefile.tools.mk with Python virtual environment support
• Implement check-codespell target: Added new spell checking workflow with smart error handling:
  • Automatically installs codespell in Python virtual environment
  • Saves spelling errors to codespell-results.txt when found
  • Displays errors on console and prompts user to fix them
  • Auto-updates results file on re-run
  • Auto-deletes results file when all errors are fixed
  • Shows success message when spelling check passes
  • Skips deploy/ directory from spell checking

Fix: #127

[vMaroon]

This looks good and useful for other llm-d repositories. I think it makes sense for this PR to include GH Actions (CI) updates too in scope - what do you think?

[nirrozenbaum]

@Jooho can you please rebase to fix the CI issue?
(the issue is now fixed and merged into main)

[elevran]

This looks good and useful for other llm-d repositories. I think it makes sense for this PR to include GH Actions (CI) updates too in scope - what do you think?

Agree. It should:

• allow the same spell check solution running both locally (via Makefile) and in CI (via a GH action)
• allow saving common dictionary in project repo (nice to have: per user dictionary under home directory?)
• be minimal and lightweight (personally prefer a solution that does not need to pull in an entire Python or JS runtime and packages, if such a solution exists. Single binary if available would be great)

@Jooho is this something you'd like to work on further?

[Jooho]

allow the same spell check solution running both locally (via Makefile) and in CI (via a GH action)
allow saving common dictionary in project repo (nice to have: per user dictionary under home directory?)

I added this part.

be minimal and lightweight (personally prefer a solution that does not need to pull in an entire Python or JS runtime and packages, if such a solution exists. Single binary if available would be great)

There is misspell go binary but I think codespell has more options and the result is better. So I want to use codespell even it is not binary.

[Jooho]

@nirrozenbaum I don't see any conflict now. can you please execute ci?

[Jooho]

@nirrozenbaum It merged master so it should pass all ci this time. can you please execute ci again?

[elevran]

There is misspell go binary but I think codespell has more options and the result is better. So I want to use codespell even it is not binary.

misspell can be added to the golangci-lint tests and would be helpful in some cases. I agree that it is not a good enough option (e.g., dictionaries are not configurable, AFAICT).
I was thinking more along the lines of C-based aspell or Rust-based typos.

For example, for typos, there's an official crate-ci/typos action for easy set-up and a binary you can download locally for use in Makefile. Both work with a .typos.toml configuration file that allows custom dictionaries and file patterns. The aspell option is similar (though I'm not aware of an official GH action, it should not be too difficult to configure one...)

[Jooho]

Sorry for the late reply — I was out this week.
@elevran No problem at all using a different CLI. This time I went with typos.
Hopefully this one's the right fit!

[elevran]

minor changes left.

[elevran]

@Jooho would you kindly fix this spelling error as part of the PR?

$ ./typos .
Warning: "Schedulling" should be "Scheduling".
error: `Schedulling` should be `Scheduling`
  --> ./docs/create_new_filter.md:118:22
    |
118 |  we leave the `types.SchedullingContext` parameter unnamed. Filters
    |                      ^^^^^^^^^^^
    |
Error: Process completed with exit code 2.

[elevran]

@Jooho -
Thanks for the PR. It's very close to completion.
Just checking up to see if you can find time to complete this or need any assistance?
Please let us know.

[Jooho]

I fixed existing typos too.