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

Add safenet docs secured #654

Merged
merged 38 commits into from
Dec 3, 2024
Merged

Add safenet docs secured #654

merged 38 commits into from
Dec 3, 2024

Conversation

valle-xyz
Copy link
Collaborator

No description provided.

Copy link

github-actions bot commented Dec 3, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Dec 3, 2024

Overall readability score: 31.35 (🟢 +0.68)

File Readability
architecture.mdx 32.22 (-)
chains.mdx 68.39 (-)
attestation.mdx 47.7 (-)
challenge.mdx 39.47 (-)
guarantee.mdx 32.68 (-)
resource-lock.mdx 50.45 (-)
settlement.mdx 45.23 (-)
universal-balance.mdx 23.84 (-)
end-user.mdx 43.12 (-)
liquidity-provider.mdx 24.23 (-)
processor.mdx 55.05 (-)
safenet-protocol.mdx 26.06 (-)
transaction-service.mdx 29.87 (-)
validator.mdx 22.91 (-)
introduction.mdx 24.8 (-)
optimistic-validity-proof.mdx 51.86 (-)
overview.mdx 68.24 (-)
beneficiary.mdx 11.16 (-)
entry-point.mdx 36.74 (-)
guarantee-engine.mdx 25.58 (-)
guarantee-implementation.mdx 32.59 (-)
guard.mdx 31.44 (-)
home-safe.mdx 51.62 (-)
overview.mdx 21.04 (-)
relayer.mdx 26.65 (-)
safe-dao.mdx 22.86 (-)
settlement-engine.mdx 33.62 (-)
transceiver.mdx 8.75 (-)
safenet-account.mdx 76.76 (-)
safenet-transaction.mdx 68.3 (-)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
architecture.mdx 32.22 31.07 13.22 15.8 17.86 8.96
  - - - - - -
chains.mdx 68.39 56.55 9.5 9.9 10.9 6.72
  - - - - - -
attestation.mdx 47.7 36.59 13.21 12.3 12.58 8.33
  - - - - - -
challenge.mdx 39.47 27.83 14.61 13.6 13.69 8.62
  - - - - - -
guarantee.mdx 32.68 26.91 14.13 16.1 16.36 8.64
  - - - - - -
resource-lock.mdx 50.45 49.75 13.79 12.6 11.02 8.39
  - - - - - -
settlement.mdx 45.23 34.46 11.68 15.7 15.2 7.12
  - - - - - -
universal-balance.mdx 23.84 18.15 15.6 16.6 17.29 9.52
  - - - - - -
end-user.mdx 43.12 27.83 13.87 11.9 11.08 9.79
  - - - - - -
liquidity-provider.mdx 24.23 25.46 18.13 12.5 15.65 11
  - - - - - -
processor.mdx 55.05 40.04 11.33 11.4 12.81 7.53
  - - - - - -
safenet-protocol.mdx 26.06 18.31 11.78 15.6 19 10.58
  - - - - - -
transaction-service.mdx 29.87 39.33 14.89 15.4 17.33 9.64
  - - - - - -
validator.mdx 22.91 24.78 17.92 15.8 14.91 10.32
  - - - - - -
introduction.mdx 24.8 22.11 14.67 16.3 18.2 9.66
  - - - - - -
optimistic-validity-proof.mdx 51.86 45.15 11.32 13.6 13.69 7.41
  - - - - - -
overview.mdx 68.24 51.44 7.83 9.9 12.28 6.79
  - - - - - -
beneficiary.mdx 11.16 9.89 18.13 17.6 18.27 10.81
  - - - - - -
entry-point.mdx 36.74 37.71 13.88 14.4 15.48 9.22
  - - - - - -
guarantee-engine.mdx 25.58 24.98 16.03 16.6 16.13 9.61
  - - - - - -
guarantee-implementation.mdx 32.59 29.04 15.68 13.7 14.96 9.65
  - - - - - -
guard.mdx 31.44 32.09 15.95 12.7 14.9 10.5
  - - - - - -
home-safe.mdx 51.62 49.11 12.31 11.1 13.1 8.55
  - - - - - -
overview.mdx 21.04 28.84 13.86 17 18.91 10.98
  - - - - - -
relayer.mdx 26.65 22.41 18 14 15.88 9.38
  - - - - - -
safe-dao.mdx 22.86 19.06 18.28 14.9 15.61 9.95
  - - - - - -
settlement-engine.mdx 33.62 33.44 16.03 14.9 14.04 9.23
  - - - - - -
transceiver.mdx 8.75 3.76 17.88 18.9 19 10.47
  - - - - - -
safenet-account.mdx 76.76 65.42 7.83 8.1 8.98 7.12
  - - - - - -
safenet-transaction.mdx 68.3 58.08 8.3 10.1 11.76 7
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 31.35 27.33 13.7 17.43 15.74 8.98
  🟢 +0.68 🟢 +0.6 🔴 -0.03 🟢 +0.37 🟢 +0.09 🔴 -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

@louis-md louis-md merged commit 2633484 into main Dec 3, 2024
4 checks passed
@louis-md louis-md deleted the addSafenetDocsSecured branch December 3, 2024 13:56
akshay-ap pushed a commit that referenced this pull request Dec 6, 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