search

iotaledger / documentation-platform

Legacy documentation platform
Apache License 2.0
52 stars 13 forks source link

Grammar & Spell-checking for Markdown #208

Closed Citrullin closed 5 years ago

Citrullin commented 5 years ago

Most IDEs only contain spell-checking. Therefore, it would make sense to add some kind of additional spell- & grammar-checking for the documentation. E.g. LanguageTool has an API for this.

We could enable to spell- & grammar-checking for every Pull-Request. Probably there is no ready-to-use solution for this.

JakeSCahill commented 5 years ago

Language tool is great. I've used it before with the term checker : https://www.simplified-english.co.uk/index.html

Mike Unwalla (the creator) allows me to use it for free for testing, but if we decide to use it, I could ask him if we could have a license

Citrullin commented 5 years ago

@JakeSCahill Sounds great. So, we could use the REST API for test purposes. Nice! I found this nodejs module. Maybe it is worth to take a look into it.

JakeSCahill commented 5 years ago

Language Tool seems to have some limitations: http://wiki.languagetool.org/public-http-api

I don't think this will work. I'm looking into some other options such as the rousseau module.

JakeSCahill commented 5 years ago

https://github.com/iotaledger/documentation/pull/194

I think grammar is a difficult one. Sometimes, it's subjective and really should be something we add to a style guide. The spell checker is a nice addition for now.

I'd recommend using this to check grammar before pushing to the repo: http://www.hemingwayapp.com/