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: broken links to SDK repo and remove references to guide #488

Merged
merged 6 commits into from
May 29, 2024

Conversation

dasanra
Copy link
Contributor

@dasanra dasanra commented May 28, 2024

Summary

  • Order the package from most used to least.
  • Removes broken links pointing to Protocol Kit reference in the repository instead the docs themselves.
  • Remove reference to guide in the repository to avoid moving users from docs to repo.
  • Add few more links for cross docs references.

Copy link

github-actions bot commented May 28, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented May 28, 2024

Overall readability score: 55.9 (🔴 -0.14)

File Readability
api-kit.mdx 55.36 (🟢 +1.01)
safe-auth.mdx 51.59 (🟢 +0)
overview.mdx 48.06 (🟢 +3.08)
protocol-kit.mdx 67.51 (🟢 +0.14)
reference.md 79.23 (🟢 +1.11)
relay-kit.mdx 49.59 (🔴 -16.3)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
api-kit.mdx 55.36 44.03 11.76 12.4 11.78 7.41
  🟢 +1.01 🟢 +0.71 🟢 +0.11 🟢 +0.4 🟢 +0.11 🔴 -0.01
safe-auth.mdx 51.59 40.95 11.48 11.3 13.1 8.49
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
overview.mdx 48.06 42.48 10.04 13.6 15.53 8.33
  🟢 +3.08 🟢 +8.56 🟢 +0.45 🟢 +0.1 🔴 -0.06 🟢 +0.26
protocol-kit.mdx 67.51 57.37 9.25 10 11.48 6.87
  🟢 +0.14 🟢 +0.41 🟢 +0.11 🟢 +0.1 🔴 -0.12 🔴 -0.03
reference.md 79.23 69.48 7.99 7.3 9.31 6.69
  🟢 +1.11 🟢 +0 🟢 +0 🔴 -0.2 🔴 -0.17 🟢 +0.51
relay-kit.mdx 49.59 53.41 11.63 13.7 12.76 8.74
  🔴 -16.3 🔴 -10.49 🔴 -2.27 🔴 -3 🔴 -2.38 🔴 -0.92

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.9 49.02 10.86 12.7 12.35 7.59
  🔴 -0.14 🔴 -0.01 🔴 -0.02 🔴 -0.03 🔴 -0.03 🟢 +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

@dasanra dasanra requested a review from germartinez May 28, 2024 15:23
pages/sdk/protocol-kit/reference.md Show resolved Hide resolved
pages/sdk/overview.mdx Show resolved Hide resolved
pages/sdk/overview.mdx Outdated Show resolved Hide resolved
pages/sdk/overview.mdx Outdated Show resolved Hide resolved
pages/sdk/relay-kit.mdx Outdated Show resolved Hide resolved
pages/sdk/protocol-kit.mdx Show resolved Hide resolved
pages/sdk/protocol-kit.mdx Outdated Show resolved Hide resolved
pages/sdk/protocol-kit.mdx Outdated Show resolved Hide resolved
@dasanra dasanra merged commit 3e99e9f into main May 29, 2024
4 checks passed
@dasanra dasanra deleted the fix-broken-links branch May 29, 2024 10:57
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