Add Vale rule reference page

[jdbaldry]

The goal of this page is to provide a human readable and singular place to reference Vale rules.

Reviewers should be primarily interested in the rendered output of the generated page: https://github.com/grafana/writers-toolkit/pull/755/files#diff-958a1da4221bf6d3444838e19159efd56e0465152a67c4294472533abb4e014d

TODO:

• Make Vale substitutions more friendly in documentation. For example, replacing '%s' with the words in the substitution or perhaps providing a table of those substitutions.

  Will likely defer this to a future PR.

Signed-off-by: Jack Baldry jack.baldry@grafana.com

[imatwawana]

Can you tell me what you're looking for in terms of review here?

[jdbaldry]

Gah, I realized I didn't save the edits to the PR title when I opened it :) Will update it

[jdbaldry]

Thanks for the suggestions @imatwawana ! I'll apply them to the source rules and regenerate the page and give you co-authored-by attribution :)

[github-actions[bot]]

Readability report

File	AutomatedReadability	ColemanLiau	FleschKincaid	FleschReadingEase	GunningFog	LIX	SMOG
docs/sources/review/lint-prose/rules.md	$${4.39\space\color{black}(Δ+0.00)}$$	$${7.74\space\color{black}(Δ+0.00)}$$	$${6.52\space\color{black}(Δ+0.00)}$$	$${58.89\space\color{black}(Δ+0.00)}$$	$${8.74\space\color{black}(Δ+0.00)}$$	$${37.22\space\color{black}(Δ+0.00)}$$	$${8.98\space\color{black}(Δ+0.00)}$$

View metric targets

| Metric | Range | Ideal score | | --- | --- | --- | | [AutomatedReadability](https://en.wikipedia.org/wiki/Automated_readability_index) | 6 (very easy read) to 14 (extremely difficult read) | 8 or less | | [ColemanLiau](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index) | 6 (very easy read) to 17 (extremely difficult read) | 9 or less | | [FleschKincaid](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) | 6 (very easy read) to 17 (extremely difficult read) | 8 or less | | [FleschReadingEase](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) | 100 (very easy read) to 0 (extremely difficult read) | 70 or more | | [GunningFog](https://en.wikipedia.org/wiki/Gunning_fog_index) | 6 (very easy read) to 17 (extremely difficult read) | 10 or less | | [LIX](https://en.wikipedia.org/wiki/Lix_(readability_test)) | 20 (very easy read) to 60+ (extremely difficult read) | 35 or less | | [SMOG](https://en.wikipedia.org/wiki/SMOG) | 6 (very easy read) to 17 (extremely difficult read) | 10 or less |