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

WIP Safenet docs first iteration #658

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

Conversation

valle-xyz
Copy link
Collaborator

PR opened to get the preview

Copy link

github-actions bot commented Dec 10, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

Overall readability score: 31.46 (🟢 +0.05)

File Readability
architecture.mdx 32.93 (🟢 +0.71)
chains.mdx 67.88 (🔴 -0.51)
introduction.mdx 34.49 (🟢 +9.69)
overview.mdx 66.42 (🔴 -1.82)
roadmap.mdx 39.85 (-)
safenet-account.mdx 76.76 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
architecture.mdx 32.93 31.38 13.35 15.4 17.51 9.02
  🟢 +0.71 🟢 +0.31 🔴 -0.13 🟢 +0.4 🟢 +0.35 🔴 -0.06
chains.mdx 67.88 56.66 9.68 9.9 11.01 6.74
  🔴 -0.51 🟢 +0.11 🔴 -0.18 🟢 +0 🔴 -0.11 🔴 -0.02
introduction.mdx 34.49 22.21 12.86 15.3 17.1 8.55
  🟢 +9.69 🟢 +0.1 🟢 +1.81 🟢 +1 🟢 +1.1 🟢 +1.11
overview.mdx 66.42 56.25 9.05 10 10.84 7.54
  🔴 -1.82 🟢 +4.81 🔴 -1.22 🔴 -0.1 🟢 +1.44 🔴 -0.75
roadmap.mdx 39.85 35.07 13.25 14.2 14.16 9.12
  - - - - - -
safenet-account.mdx 76.76 65.42 7.83 8.1 8.98 7.12
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 31.46 27.4 13.69 17.39 15.72 8.98
  🟢 +0.05 🟢 +0.04 🟢 +0 🟢 +0.01 🟢 +0.01 🟢 +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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants