Add automatic spell checker as part of CI?

[Sajjon]

I recently fixed some typos in https://github.com/apple/swift-book/pull/11 and since this is a repo for a book, spelling and grammar is extra important (compared to code repo).

Has anyone any experience with Github Actions for Spell Checking, e.g. this: https://github.com/marketplace/actions/check-spelling ?

[krilnon]

I don't think any Apple repos have GitHub Actions enabled right now, but we can use this issue to discuss the kinds of prose checks that we might want to add to CI.

[Sajjon]

@krilnon Alternatively could be tool run part of some git hook, to avoid using GitHub Actions..?

[franklinsch]

It would be nice to integrate this directly in Swift-DocC tooling as well in some way, since spell-checking could provide generally-useful diagnostics at build-time.

[krilnon]

One interesting thing about your fixes in #11 are that they were mostly inside of @Comment blocks, which I'm not sure we'd want to block on in CI. DocC would be better positioned to check only the text that's going to display as documentation, and could selectively include or exclude things like code blocks.

[franklinsch]

https://github.com/apple/swift-docc/issues/377 tracks this issue in DocC.