Skip to content

fix: Update link format and broken links #737

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

germartinez
Copy link
Contributor

@germartinez germartinez commented Apr 14, 2025

What it solves

Resolves https://github.com/safe-global/developer-experience/issues/400

[something](/something) => [something](./something.md)
[something](/something) => [something](./something.mdx)
[something](./something) => [something](./something.md)
[something](./something) => [something](./something.mdx)
[something](./something#somethingelse) => [something](./something.md#somethingelse)
[something](./something#somethingelse) => [something](./something.mdx#somethingelse)

Changelog

  • Adds a script that checks all links follow the right format and finds all the ons that don't follow it.
  • Updates all links to this format
  • Fixes broken links
  • Updates redirects

Dependencies

  • This PR depends on fix(API): Replace v1 with v2 endpoints #735. Once it is merged this needs to be rebased and update the link [multiple networks](../../../core-api/transaction-service-supported-networks) that currently doesn't follow the new format, and regenerate the references.

Checklist

Copy link

github-actions bot commented Apr 14, 2025

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

Overall readability score: 36.41 (🔴 -0.01)

File Readability
overview.mdx 41.38 (🟢 +0)
overview.mdx 52.32 (🟢 +0)
extend.mdx 18.13 (🟢 +0)
overview.mdx 37.21 (🟢 +0)
glossary.md 55.41 (🟢 +0)
transaction-service-overview.mdx 49.41 (🟢 +0)
overview.mdx 47.81 (🔴 -4.87)
add-or-edit-chain.mdx 85.83 (🟢 +0)
smart-account-overview.mdx 59.59 (🟢 +0)
smart-account-modules.mdx 35.24 (🟢 +0)
smart-account-concepts.mdx 68.5 (🟢 +0)
passkeys-safe.mdx 42.23 (🟢 +0)
react-native.mdx 63.35 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
overview.mdx 41.38 32.39 10.83 15.3 16.81 8.14
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
overview.mdx 52.32 62.38 10 17.5 14.09 6.92
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
extend.mdx 18.13 0 11.76 22 19 9.22
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
overview.mdx 37.21 51.18 13 19.9 14.5 8.18
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
glossary.md 55.41 39.33 10.24 12.3 13.39 7.3
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
transaction-service-overview.mdx 49.41 45.66 11.17 14.5 13.92 7.77
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
overview.mdx 47.81 39.74 9.76 13.6 15.25 8.54
  🔴 -4.87 🔴 -8.66 🟢 +0.36 🔴 -1.8 🔴 -1.8 🟢 +0.34
add-or-edit-chain.mdx 85.83 70.19 6.49 6.6 8.79 6.02
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
smart-account-overview.mdx 59.59 45.66 9.66 12.3 12.7 6.94
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
smart-account-modules.mdx 35.24 30.77 13.51 14.1 15.42 9.69
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
smart-account-concepts.mdx 68.5 56.45 8.95 10.4 11.42 6.52
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
passkeys-safe.mdx 42.23 35.68 11.74 15.4 15.72 7.99
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
react-native.mdx 63.35 54.52 9.96 11.3 11.19 7.18
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 36.41 32.29 13.08 16.47 15.15 8.68
  🔴 -0.01 🔴 -0.02 🟢 +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

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