Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: move examples into code blocks #397

Merged
merged 1 commit into from
Dec 7, 2023

Conversation

imatwawana
Copy link
Contributor

No description provided.

@imatwawana imatwawana added the type/docs Docs Squad label used across all Grafana Labs repos label Dec 6, 2023
@imatwawana imatwawana self-assigned this Dec 6, 2023
Copy link
Contributor

github-actions bot commented Dec 6, 2023

Overall readability score: 60.79 (🟢 +0)

File Readability
index.md 75.42 (🟢 +0.08)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
index.md 75.42 53.07 6.86 8.8 10.76 6.32
  🟢 +0.08 🟢 +0 🟢 +0 🟢 +0 🟢 +0.06 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.79 47.6 9.56 11.61 12.06 7.31
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

Copy link
Contributor

@josmperez josmperez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@imatwawana imatwawana merged commit b1e4977 into main Dec 7, 2023
7 checks passed
@imatwawana imatwawana deleted the ihm/061223-examples-in-code-blocks branch December 7, 2023 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label used across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants