Recipe·Design recipes·RC10

Clean up a repo's docs

Get a noisy first run of Vale (the prose checker) down to problems worth fixing.

Markdown

Steps

  1. 1  /vale:triage decide per rule: fix, downgrade or switch off
  2. 2  /vale:vocab teach it your product names
  3. 3  /vale:fix fix the error-level alerts that remain
  4. 4  /humanizer rewrite the pages that still read as machine-made
As one prompt
Clean up a repo's docs. Get a noisy first Vale run down to something worth fixing.
Run these in order, and check in with me between steps:
1. /vale:triage: decide per rule: fix, downgrade or switch off
2. /vale:vocab: teach it your product names
3. /vale:fix: fix the error-level alerts that remain
4. /humanizer: rewrite the pages that still read as machine-made

More in Design recipes.