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

fix: Add cards to Infrastructure Overview #479

Merged
merged 4 commits into from
May 28, 2024
Merged

Conversation

tanay1337
Copy link
Collaborator

No description provided.

@tanay1337 tanay1337 requested a review from germartinez May 21, 2024 11:57
Copy link

github-actions bot commented May 21, 2024

Branch preview

✅ Deployed successfully in branch deployment:

https://api_overview_refactor--docs.review.5afe.dev

Copy link

github-actions bot commented May 21, 2024

Overall readability score: 55.96 (🔴 -0.21)

File Readability
api-overview.mdx 25.2 (🔴 -23.54)
transaction-service-overview.mdx 49.56 (🟢 +7.4)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
api-overview.mdx 25.2 22.65 14.44 19.4 17.18 8.73
  🔴 -23.54 🔴 -15.87 🔴 -3.79 🔴 -5.8 🔴 -2.22 🔴 -0.89
transaction-service-overview.mdx 49.56 45.66 11.17 14.4 13.92 7.77
  🟢 +7.4 🟢 +2.74 🟢 +1.6 🟢 +1.7 🟢 +0.41 🟢 +0.36

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.96 48.9 10.77 12.72 12.38 7.6
  🔴 -0.21 🔴 -0.17 🔴 -0.03 🔴 -0.05 🔴 -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

@germartinez germartinez changed the title fix: rearrange information to reduce visual overload for Infrastructure Overview fix: Add cards to Infrastructure Overview May 22, 2024
@tanay1337 tanay1337 requested a review from germartinez May 27, 2024 16:02
tanay1337 and others added 2 commits May 27, 2024 18:46
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
@tanay1337 tanay1337 requested a review from germartinez May 27, 2024 16:46
@tanay1337 tanay1337 merged commit efdd447 into main May 28, 2024
4 checks passed
@tanay1337 tanay1337 deleted the api-overview-refactor branch May 28, 2024 05:49
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.

2 participants