grafana / writers-toolkit

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

Review 'GNU Make help output' shared page #691

Closed jdbaldry closed 4 months ago

jdbaldry commented 4 months ago

Rest LGTM

Closes https://github.com/grafana/writers-toolkit/issues/687

github-actions[bot] commented 4 months ago

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/shared/make-help.md $${8.40\space\color{red}(Δ+0.54)}$$ $${11.73\space\color{red}(Δ+0.30)}$$ $${10.59\space\color{red}(Δ+0.11)}$$ $${39.42\space\color{green}(Δ+0.95)}$$ $${12.98\space\color{green}(Δ-0.41)}$$ $${41.22\space\color{red}(Δ+1.97)}$$ $${13.02\space\color{red}(Δ+0.33)}$$
docs/sources/structure/_index.md $${7.71\space\color{green}(Δ-0.24)}$$ $${10.34\space\color{red}(Δ+0.02)}$$ $${8.49\space\color{green}(Δ-0.39)}$$ $${56.73\space\color{green}(Δ+1.55)}$$ $${10.19\space\color{green}(Δ-0.11)}$$ $${36.48\space\color{green}(Δ-0.34)}$$ $${10.84\space\color{green}(Δ-0.03)}$$
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 |