grafana / writers-toolkit

Technical documentation guidelines for Grafana Labs documentation
https://grafana.com/docs/writers-toolkit/
16 stars 12 forks source link

docs: extend skip rules example #735

Closed JStickler closed 3 weeks ago

JStickler commented 4 weeks ago

Fleshing this out a little, because for some reason I did NOT understand how to do this when I first read it and just copy/pasted the example. Which of course, isn't how it works....

github-actions[bot] commented 4 weeks ago

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/review/lint-prose/_index.md $${5.62\space\color{red}(Δ+0.08)}$$ $${8.81\space\color{red}(Δ+0.06)}$$ $${7.04\space\color{red}(Δ+0.05)}$$ $${62.11\space\color{red}(Δ-0.20)}$$ $${9.60\space\color{red}(Δ+0.10)}$$ $${31.42\space\color{red}(Δ+0.59)}$$ $${10.29\space\color{red}(Δ+0.10)}$$
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 |
jdbaldry commented 4 weeks ago

Thank you for the contribution!