[CI] Spell-check for documentation? about docs

As a maintainer and avid grammarian, I would love if the spell check could check the description field of links.json.
This snippet would extract them when executed in a track's repository:

find . -name 'links.json'  | xargs jq '.[] | .description'

[iHiD]

@SaschaMann This is a good target for an org-wide check.

Great idea @wolf99! There is a plugin retext-spell that uses Hunspell I think. I've seen other OSS teams leverage this to unify contributions in a great way. (https://github.com/ember-learn/guides-source/blob/d35a871a417e9c425a945369b849b0864cba1a23/.remarkrc.js has an example configuration for remark)

[wolf99]

Possibly also @SaschaMann as CI related, I think that's your wheelhouse - thoughts?

[SaschaMann]

Sounds good. Ideally it should add inline annotations or, better yet, suggestions to automatically fix the spelling mistake. Perhaps there are actions for it on the marketplace already. I think having it as a normal pass/fail check might be quite bothersome.

[wolf99]

Good suggestions both.
I'll look into it for PR. I'm not at all au fait with GitHub actions so it may take a wee while 😄 )

[wolf99]

Just as FYI here, life has got really busy since making above assertion. I'm having trouble fitting time in for even any v2 track maintenance effort. So if anyone else wants to pick this up until I get back to things, be my guest 😉

This action has the most actions stars: https://github.com/marketplace/actions/github-spellcheck-action

• uses pyspelling
• aspell or hunspell