docs icon indicating copy to clipboard operation
docs copied to clipboard

Add GitHub check for spelling

Open daixiang0 opened this issue 4 years ago • 4 comments

I would like to introduce a spelling tool to do spell lint, it would help Improve document quality and help review if possible.

daixiang0 avatar Jul 16 '21 07:07 daixiang0

@daixiang0 do you mean adding spell checks to the CI process? Is there a specific tool you have in mind?

orizohar avatar Jul 16 '21 17:07 orizohar

I use https://github.com/client9/misspell for myself, it is pretty good.

daixiang0 avatar Jul 19 '21 01:07 daixiang0

@daixiang0, @orizohar - Is this still an open issue? I wonder if GitHub Super Linter may be an option. Rather than just doing spell lint, it could also lint any markdown which is created as well.

There is a GitHub action available (I use it on my own blog static site workflow), and it has support for textlint, which relates to natural language. Full list of linters it supports is available here.

chrisreddington avatar Jan 07 '22 11:01 chrisreddington

Still available, you can pick it @chrisreddington

daixiang0 avatar Sep 07 '22 08:09 daixiang0

closing for now - let me know if ready to start working on this and I will reopen.

hhunter-ms avatar Jul 13 '23 21:07 hhunter-ms