Skip to content

Update docs complexity #2440

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

Merged
merged 5 commits into from
Jul 31, 2025
Merged

Update docs complexity #2440

merged 5 commits into from
Jul 31, 2025

Conversation

stefanvacareanu7
Copy link
Contributor

👀 Live preview

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

@stefanvacareanu7 stefanvacareanu7 requested a review from a team as a code owner July 31, 2025 11:18
Copy link
Contributor

Overall readability score: 53.08 (🟢 +0)

File Readability
codacy-configuration-file.md 55.59 (🔴 -0.83)
which-metrics-does-codacy-calculate.md 59.6 (🔴 -0.05)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
codacy-configuration-file.md 55.59 36.28 10.28 13.4 13.16 6.67
  🔴 -0.83 🔴 -0.21 🔴 -0.15 🔴 -0.2 🔴 -0.11 🔴 -0.03
which-metrics-does-codacy-calculate.md 59.6 38.01 9.66 12.1 12.93 6.53
  🔴 -0.05 🔴 -0.41 🔴 -0.06 🔴 -0.1 🟢 +0.12 🟢 +0.03

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.08 42.94 10.95 12.69 12.63 7.99
  🟢 +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

@github-actions github-actions bot temporarily deployed to Netlify July 31, 2025 11:19 Inactive
@stefanvacareanu7 stefanvacareanu7 enabled auto-merge (squash) July 31, 2025 11:43
@stefanvacareanu7 stefanvacareanu7 merged commit 90dafaa into master Jul 31, 2025
5 checks passed
@stefanvacareanu7 stefanvacareanu7 deleted the update-docs-complexity branch July 31, 2025 15:17
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.

3 participants