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 cURL examples' endpoints in API reference #679

Merged
merged 8 commits into from
Jan 23, 2025
Merged

Conversation

louis-md
Copy link
Collaborator

@louis-md louis-md requested a review from tanay1337 January 21, 2025 16:56
Copy link

github-actions bot commented Jan 21, 2025

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Jan 21, 2025

Overall readability score: 32.83 (🟢 +1.28)

File Readability
arbitrum-reference.mdx 51.71 (-)
aurora-reference.mdx 51.71 (-)
avalanche-reference.mdx 51.71 (-)
base-reference.mdx 51.71 (-)
base-sepolia-reference.mdx 51.71 (-)
blast-reference.mdx 51.71 (-)
bsc-reference.mdx 51.71 (-)
celo-reference.mdx 51.71 (-)
chiado-reference.mdx 51.71 (-)
gnosis-chain-reference.mdx 51.71 (-)
linea-reference.mdx 51.71 (-)
mainnet-reference.mdx 51.71 (-)
mantle-reference.mdx 51.71 (-)
optimism-reference.mdx 51.71 (-)
polygon-reference.mdx 51.71 (-)
scroll-reference.mdx 51.71 (-)
sepolia-reference.mdx 51.71 (🟢 +1.77)
worldchain-reference.mdx 51.71 (-)
xlayer-reference.mdx 51.71 (-)
zkevm-reference.mdx 51.71 (-)
zksync-reference.mdx 51.71 (-)
arbitrum.mdx 0 (🟢 +0)
aurora.mdx 0 (🟢 +0)
avalanche.mdx 0 (🟢 +0)
base-sepolia.mdx 0 (🟢 +0)
base.mdx 0 (🟢 +0)
blast.mdx 0 (🟢 +0)
bsc.mdx 0 (🟢 +0)
celo.mdx 0 (🟢 +0)
chiado.mdx 0 (🟢 +0)
gnosis-chain.mdx 0 (🟢 +0)
linea.mdx 0 (🟢 +0)
mainnet.mdx 0 (🟢 +0)
mantle.mdx 0 (🟢 +0)
optimism.mdx 0 (🟢 +0)
polygon.mdx 0 (🟢 +0)
scroll.mdx 0 (🟢 +0)
sepolia.mdx 0 (🟢 +0)
worldchain.mdx 0 (🟢 +0)
xlayer.mdx 0 (🟢 +0)
zkevm.mdx 0 (🟢 +0)
zksync.mdx 0 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
arbitrum-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
aurora-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
avalanche-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
base-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
base-sepolia-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
blast-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
bsc-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
celo-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
chiado-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
gnosis-chain-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
linea-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
mainnet-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
mantle-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
optimism-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
polygon-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
scroll-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
sepolia-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  🟢 +1.77 🟢 +8.46 🟢 +0.07 🟢 +0 🟢 +0.11 🟢 +0.03
worldchain-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
xlayer-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
zkevm-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
zksync-reference.mdx 51.71 50.36 12.09 14.6 12.42 7.42
  - - - - - -
arbitrum.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
aurora.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
avalanche.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
base-sepolia.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
base.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
blast.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
bsc.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
celo.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
chiado.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
gnosis-chain.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
linea.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
mainnet.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
mantle.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
optimism.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
polygon.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
scroll.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
sepolia.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
worldchain.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
xlayer.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
zkevm.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
zksync.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 32.83 28.86 13.56 17.21 15.51 8.87
  🟢 +1.28 🟢 +1.45 🟢 +0.11 🟢 +0.18 🟢 +0.2 🟢 +0.1
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

@louis-md louis-md merged commit 1c05c46 into main Jan 23, 2025
3 of 4 checks passed
@louis-md louis-md deleted the fix-api-reference branch January 23, 2025 09:33
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