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

4337 API Reference #477

Merged
merged 5 commits into from
May 17, 2024
Merged

4337 API Reference #477

merged 5 commits into from
May 17, 2024

Conversation

louis-md
Copy link
Collaborator

Get endpoint categories from swagger tags; regenerate references; add metadata to new paths

@louis-md louis-md requested a review from tanay1337 May 17, 2024 14:16
Copy link

github-actions bot commented May 17, 2024

Branch preview

✅ Deployed successfully in branch deployment:

https://4337_api_reference--docs.review.5afe.dev

Copy link

github-actions bot commented May 17, 2024

Overall readability score: 56.09 (🟢 +0.1)

File Readability
generated-reference.mdx 41.62 (🟢 +7.95)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
generated-reference.mdx 41.62 35.2 14.06 18 12.83 7.01
  🟢 +7.95 🔴 -0.51 🟢 +1.43 🟢 +0.6 🟢 +0.58 🟢 +1.21

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.09 48.94 10.78 12.67 12.35 7.59
  🟢 +0.1 🔴 -0.01 🟢 +0.02 🟢 +0.01 🟢 +0.01 🟢 +0.02
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

@tanay1337 tanay1337 merged commit b19ed6d into main May 17, 2024
4 checks passed
@tanay1337 tanay1337 deleted the 4337-api-reference branch May 17, 2024 15:51
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