developers.sparkpost.com icon indicating copy to clipboard operation
developers.sparkpost.com copied to clipboard

Add textlint

Open avigoldman opened this issue 5 years ago • 0 comments

We should have some linting on the API reference content to help fix common errors:

textlint rules:

  • alex
  • max-comma (max 3)
  • terminology terms: SMTP, Transmissions API etc., SparkPost, MTA, Message Systems, Momentum, Port25, TPS and other protocols, JSON, PHP and other library languages,
  • write-good options: weasel, adverbs, so, illusion, cliches
  • spellchecker
  • stop-words (This might be too aggressive for us)

avigoldman avatar Jul 23 '18 21:07 avigoldman