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

docs: Update Protocol Kit redirects and RemovedContentCallout #637

Merged
merged 2 commits into from
Oct 31, 2024

Conversation

germartinez
Copy link
Member

@germartinez germartinez commented Oct 31, 2024

Context

This PR:

  • Updates Protocol Kit Reference redirects
  • Updates the RemovedContentCallout component to pass the content as a children instead of string to handle links correctly and formatted words.

Copy link

github-actions bot commented Oct 31, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Oct 31, 2024

Overall readability score: 30.96 (🔴 -0.18)

File Readability
overview.mdx 20.97 (-)
onramp.mdx 48.99 (🟢 +0)
monerium.mdx 66.58 (🟢 +0)
stripe.mdx 49.01 (🟢 +0)
execute-transactions.mdx 69.15 (🟢 +0)
multichain-safe-deployment.mdx 34.01 (🟢 +3.21)
safe-deployment.mdx 24.01 (🟢 +0)
signers.mdx 45.27 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
overview.mdx 20.97 8.03 13 19.3 19 9.31
  - - - - - -
onramp.mdx 48.99 37.81 10.24 14.2 14.67 7.8
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
monerium.mdx 66.58 49.31 8.59 10.4 11.77 6.79
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
stripe.mdx 49.01 40.35 9.07 15.5 15.88 7.43
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
execute-transactions.mdx 69.15 56.96 9.11 9.9 10.84 6.74
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
multichain-safe-deployment.mdx 34.01 41.53 15.13 20.7 13.36 7.68
  🟢 +3.21 🟢 +2.03 🟢 +0.77 🟢 +0.9 🔴 -0.12 🟢 +0.13
safe-deployment.mdx 24.01 30.13 17.01 22 13.76 8.44
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
signers.mdx 45.27 29.86 10.57 14.8 15.54 7.72
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 30.96 26.38 13.5 18.06 15.94 8.78
  🔴 -0.18 🔴 -0.22 🔴 -0.01 🔴 -0.04 🔴 -0.03 🔴 -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 docs: Fix links in RemovedContentCallout docs: Fix links and format in RemovedContentCallout Oct 31, 2024
@germartinez germartinez changed the title docs: Fix links and format in RemovedContentCallout docs: Update Protocol Kit redirects and RemovedContentCallout Oct 31, 2024
@germartinez germartinez merged commit b4bb9a5 into main Oct 31, 2024
4 checks passed
@germartinez germartinez deleted the update-callout branch October 31, 2024 15:24
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