safe-docs icon indicating copy to clipboard operation
safe-docs copied to clipboard

Development

Open germartinez opened this issue 1 year ago • 1 comments

Context

This PR adds:

  • Update Protocol Kit initialization (EIP-1193)
  • Update API Kit guide signing flow

germartinez avatar May 08 '24 10:05 germartinez

Overall readability score: 56.59 (🟢 +0.35)

File Readability
delegates.mdx 14.71 (🔴 -1.59)
messages.mdx 8.19 (🟢 +1.39)
transactions.mdx 8.92 (🟢 +0.67)
api-kit.mdx 54.35 (🔴 -7.75)
migrate-to-v1.md 67.43 (🟢 +0)
migrate-to-v2.md 62.94 (🟢 +0)
safe-auth.mdx 51.13 (🔴 -0.98)
protocol-kit.mdx 67.38 (🔴 -3.25)
signatures.md 62.99 (🟢 +0.27)
messages.mdx 75.05 (🟢 +0)
transactions.mdx 45.04 (🟢 +0.08)
migrate-to-v1.md 81.27 (🟢 +0)
migrate-to-v2.md 70.41 (🟢 +0)
migrate-to-v3.md 71.32 (-)
migrate-to-v4.md 68.79 (-)
safe-factory.md 59.97 (🟢 +3.22)
safe.md 70.29 (🟢 +0.66)
4337-safe-sdk.mdx 32.31 (🟢 +0.45)
gelato-relay.mdx 66.67 (🟢 +0)
migrate-to-v2.md 20.34 (🟢 +0)
migrate-to-v3.md 63.48 (-)
safe-4337-pack.mdx 60.43 (🟢 +0.01)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
delegates.mdx 14.71 1.63 14.25 22 19 9.04
  🔴 -1.59 🟢 +1.63 🔴 -1.12 🟢 +0 🟢 +0 🟢 +0.02
messages.mdx 8.19 0 18.57 22 19 8.68
  🟢 +1.39 🟢 +0 🟢 +0.06 🟢 +0 🟢 +0 🟢 +0.4
transactions.mdx 8.92 0 18.8 22 19 8.33
  🟢 +0.67 🟢 +0 🔴 -0.17 🟢 +0 🟢 +0 🟢 +0.3
api-kit.mdx 54.35 43.32 11.87 12.8 11.89 7.4
  🔴 -7.75 🔴 -10.9 🔴 -1.03 🔴 -1.8 🔴 -0.93 🔴 -0.08
migrate-to-v1.md 67.43 46.03 8.5 9.3 12.32 6.66
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v2.md 62.94 48.6 11.03 9.5 10.72 7.45
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
safe-auth.mdx 51.13 40.95 11.75 11.3 13.1 8.49
  🔴 -0.98 🔴 -0.41 🔴 -0.53 🟢 +0.2 🟢 +0.11 🔴 -0.14
protocol-kit.mdx 67.38 56.96 9.36 10.1 11.36 6.84
  🔴 -3.25 🔴 -0.91 🔴 -0.56 🔴 -0.7 🔴 -0.41 🔴 -0.17
signatures.md 62.99 55.64 9.88 11.9 12.35 6.61
  🟢 +0.27 🟢 +0.2 🟢 +0.04 🟢 +0.1 🟢 +0.06 🔴 -0.02
messages.mdx 75.05 64 8.29 9.8 10.15 6.05
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
transactions.mdx 45.04 52.8 9.48 19.5 19 5.91
  🟢 +0.08 🟢 +0 🟢 +0.03 🟢 +0 🟢 +0 🟢 +0.01
migrate-to-v1.md 81.27 67.65 7.9 8.1 8.51 6
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v2.md 70.41 59.09 10.7 7.1 8.34 7.97
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v3.md 71.32 65.73 10.74 7.7 8.4 7.71
  - - - - - -
migrate-to-v4.md 68.79 57.87 9.66 9 10.32 7.24
  - - - - - -
safe-factory.md 59.97 55.13 10.94 11.3 11.6 7.56
  🟢 +3.22 🟢 +8.35 🟢 +0.1 🟢 +0.4 🟢 +0.52 🟢 +0.11
safe.md 70.29 42.48 7.13 10.4 12.46 5.76
  🟢 +0.66 🟢 +0 🟢 +0.02 🟢 +0.2 🟢 +0.17 🟢 +0.03
4337-safe-sdk.mdx 32.31 43.8 17.61 21.1 11.15 7.79
  🟢 +0.45 🟢 +0.3 🟢 +0.16 🟢 +0.1 🔴 -0.06 🟢 +0.02
gelato-relay.mdx 66.67 54.42 9.56 10.5 10.79 6.89
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v2.md 20.34 0 14.74 17.3 19 9.07
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v3.md 63.48 48.91 11.33 8.9 9.97 7.74
  - - - - - -
safe-4337-pack.mdx 60.43 34.12 8.15 11.7 14.25 6.48
  🟢 +0.01 🔴 -0.1 🟢 +0.06 🟢 +0 🔴 -0.12 🟢 +0.03

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.59 49.29 10.77 12.48 12.24 7.58
  🟢 +0.35 🟢 +0.3 🔴 -0.03 🟢 +0.13 🟢 +0.1 🟢 +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

github-actions[bot] avatar May 08 '24 10:05 github-actions[bot]

Branch preview

✅ Deployed successfully in branch deployment:

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

github-actions[bot] avatar May 10 '24 11:05 github-actions[bot]