Add visualization topic examples

jdbaldry commented 3 weeks ago

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

Replaces https://github.com/grafana/writers-toolkit/pull/734

github-actions[bot] commented 3 weeks ago

Readability report

File	AutomatedReadability	ColemanLiau	FleschKincaid	FleschReadingEase	GunningFog	LIX	SMOG
docs/sources/structure/topic-types/visualization/index.md	$${7.30\space\color{green}(Δ-0.12)}$$	$${10.94\space\color{green}(Δ-0.04)}$$	$${9.72\space\color{green}(Δ-0.08)}$$	$${42.78\space\color{red}(Δ-0.02)}$$	$${9.90\space\color{green}(Δ-0.18)}$$	$${38.19\space\color{green}(Δ-0.30)}$$	$${10.74\space\color{green}(Δ-0.11)}$$

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 3 weeks ago

If it changes your mind, this is consistent with the other topics documentation:

grafana / writers-toolkit

Add visualization topic examples #736

Readability report