Check Spelling in Starlight Docs

[trueberryless]

Over the last week I implemented the Github Action spell-ckecking into my own repo which uses Starlight.

I think it would be great to also implement such a feature in the Starlight Docs and I am willing to create a PR which implements the check-spelling Action if the community decides that Starlight should implement this feature.

[at-the-vr]

I am neutral on this case, its good to have but with all the linting and formatting I find myself delayed overtime. I find this in my lowest priorities (subjectively). It is nicely maintained and documented 💯

[delucis]

This is a cool idea! I wonder if you could publish this as a community add-on package a bit like https://github.com/HiDeoo/starlight-links-validator ?

[HiDeoo]

Oh I should have been more clear. I meant either a JS or composite GitHub Action that would re-use this one but with extra features dedicated to Starlight, e.g. automatic configuration of the dictionnaries based on the Starlight configured locales, etc.

[trueberryless]

I can give you some examples of my repo where this action helps out a lot:

• Commenting on commits: trueberryless-org/mutanuq@dbe0c2b#commitcomment-132435149
• Commenting on Pull Request (with updates when new commits): Update allow words trueberryless-org/mutanuq#35 (comment)
• Creating entries in Security tab for misspellings: https://github.com/trueberryless-org/mutanuq/security/code-scanning?query=is%3Aclosed+branch%3Amain

and much more. You can see every feature of this Github Action right here

[trueberryless]

Oh I should have been more clear. I meant either a JS or composite GitHub Action that would re-use this one but with extra features dedicated to Starlight, e.g. automatic configuration of the dictionaries based on the Starlight configured locales, etc.

Okay, this is a very good idea! Haven't though about that one before...

[jasikpark]

HiDeoo/starlight-links-validator

does this work for generic astro sites as well?

[HiDeoo]

does this work for generic astro sites as well?

I did not try it but in the current state, I think it could (or at least should be able with not a lot of modifications) altho my plan is to convert the integration into a Starlight plugin when possible to add more Starlight specific feature like support for Starlight fallback pages and same-locale links (which would use the Starlight locales config). At this point, this would no longer an option at all.