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: Update broken links #636

Merged
merged 3 commits into from
Oct 28, 2024
Merged

fix: Update broken links #636

merged 3 commits into from
Oct 28, 2024

Conversation

germartinez
Copy link
Member

@germartinez germartinez commented Oct 28, 2024

Context

This PR:

  • Fixes broken links in the docs.

Note:

  • There is a broken link in the Protocol Kit guide. This is expected and can't be fixed at this point as it is pointing to a method that no longer exists in the Protocol Kit reference. It will be fixed/replaced when the new Protocol Kit guide is live.

@germartinez germartinez requested a review from tanay1337 October 28, 2024 14:05
Copy link

github-actions bot commented Oct 28, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Oct 28, 2024

Overall readability score: 31.17 (🟢 +0)

File Readability
unattended-commands.mdx 61.68 (🟢 +0)
permissionless-quickstart.mdx 36.31 (🟢 +0)
nuxt.mdx 70.07 (🟢 +0)
react.mdx 71.81 (🟢 +0)
smart-account-bug-bounty.md 53.46 (🟢 +0)
glossary.md 55.8 (🟢 +0)
safe-core.mdx 15.6 (🟢 +0)
overview.mdx 43.77 (🟢 +0)
useconfirmtransaction.mdx 36.09 (🟢 +0)
usesendtransaction.mdx 42.63 (🟢 +0)
add.mdx 49.07 (🟢 +0)
remove.mdx 47.99 (🟢 +0)
swap.mdx 48.6 (🟢 +0)
useupdatethreshold.mdx 39.71 (🟢 +0)
constructor.mdx 56.98 (🟢 +0)
api-kit.mdx 31.74 (🟢 +0)
propose-and-confirm-transactions.mdx 63.1 (🟢 +0)
monerium.mdx 66.58 (🟢 +0.05)
stripe.mdx 49.01 (🟢 +0)
protocol-kit.mdx 32.96 (🟢 +0)
execute-transactions.mdx 69.15 (🔴 -0.08)
react-hooks.mdx 44.12 (🟢 +0)
starter-kit.mdx 52.24 (🟢 +0)
send-user-operations.mdx 28.33 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
unattended-commands.mdx 61.68 48.5 9.85 10.7 11.71 7.49
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
permissionless-quickstart.mdx 36.31 43.77 15.18 18.6 12.89 8.21
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
nuxt.mdx 70.07 55.64 9.32 9.5 10.03 6.81
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
react.mdx 71.81 64.3 9.15 9.5 9.97 6.83
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
smart-account-bug-bounty.md 53.46 39.53 10.78 12.4 13.45 7.56
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
glossary.md 55.8 39.33 10.24 12.2 13.22 7.3
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
safe-core.mdx 15.6 21.33 17.03 22 17.87 8.79
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
overview.mdx 43.77 57.27 11.31 18.7 13.62 8.28
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
useconfirmtransaction.mdx 36.09 25.66 9.38 18.2 18.66 8.09
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
usesendtransaction.mdx 42.63 32.7 9.46 16.9 16.75 7.8
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
add.mdx 49.07 34.42 8.93 14.5 15.23 7.92
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
remove.mdx 47.99 34.42 8.95 14.8 15.64 7.93
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
swap.mdx 48.6 34.42 8.95 14.6 15.41 7.93
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
useupdatethreshold.mdx 39.71 25.66 9.15 17.3 17.62 7.95
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
constructor.mdx 56.98 51.44 9.81 12.3 12.51 8.05
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
api-kit.mdx 31.74 32.73 14.18 17.2 15.03 9.29
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
propose-and-confirm-transactions.mdx 63.1 54.93 11.03 10.2 10.61 7.46
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
monerium.mdx 66.58 49.31 8.59 10.4 11.77 6.79
  🟢 +0.05 🟢 +0 🟢 +0.01 🟢 +0 🟢 +0 🟢 +0.01
stripe.mdx 49.01 40.35 9.07 15.5 15.88 7.43
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
protocol-kit.mdx 32.96 37.5 15.08 15 15.08 9.65
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
execute-transactions.mdx 69.15 56.96 9.11 9.9 10.84 6.74
  🔴 -0.08 🔴 -0.1 🟢 +0.04 🔴 -0.1 🔴 -0.06 🟢 +0.03
react-hooks.mdx 44.12 39.67 12.68 15.6 13 8.21
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
starter-kit.mdx 52.24 46.47 11.83 12.8 12.82 7.83
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
send-user-operations.mdx 28.33 35.65 17.52 21.9 11.44 8.17
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 31.17 26.53 13.47 17.99 15.92 8.78
  🟢 +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

@germartinez germartinez merged commit 7878cee into main Oct 28, 2024
4 checks passed
@germartinez germartinez deleted the fix-links branch October 28, 2024 15:00
@germartinez germartinez changed the title Fix: Update broken links fix: Update broken links Oct 28, 2024
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