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

Add readability report and secrets: bug fix #794

Merged
merged 21 commits into from
Jan 10, 2025
Merged

Conversation

cansavvy
Copy link
Collaborator

Summary

Addresses #787 by adding a readability report!

@cansavvy cansavvy changed the title Add readability report Add readability report and secrets: bug fix Jan 10, 2025
Copy link
Contributor

github-actions bot commented Jan 10, 2025

No broken url errors! 🎉
Comment updated at 2025-01-10-18:53:56 with changes from 69b351e

Copy link
Contributor

github-actions bot commented Jan 10, 2025

No spelling errors! 🎉
Comment updated at 2025-01-10-18:53:56 with changes from 69b351e

@cansavvy
Copy link
Collaborator Author

Overall readability score: 57.92 (🟢 +0.07)

File Readability
README.md 64.84 (🟢 +1.66)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
README.md 64.84 52.76 8.23 9.5 12.15 7.94
  🟢 +1.66 🟢 +0.3 🟢 +0 🟢 +0.4 🟢 +0.41 🟢 +0.14

Averages:

  Readability FRE GF ARI CLI DCRS
Average 57.92 51.12 10.12 13.09 12.18 7.37
  🟢 +0.07 🟢 +0.01 🟢 +0 🟢 +0.02 🟢 +0.02 🟢 +0.01
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

Re-rendered previews from the latest commit:

* note not all html features will be properly displayed in the "quick preview" but it will give you a rough idea.

Updated at 2025-01-10 with changes from the latest commit 69b351e

@cansavvy cansavvy merged commit 5f19480 into main Jan 10, 2025
12 checks passed
@cansavvy cansavvy deleted the cansavvy/markdown-2 branch January 10, 2025 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant