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

docs: Add reference for relay-kit

Open dasanra opened this issue 2 years ago • 1 comments

Context

This PR:

  • TBD

dasanra avatar Dec 27 '23 15:12 dasanra

Overall readability score: 70.16 (🔴 -0.36)

File Readability
gelato.md 75.59 (🟢 +0.53)
GelatoRelayPack.md 69.88 (-)
README.md 80.06 (🔴 -19.94)
RelayKitBasePack.md 70.74 (-)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
gelato.md 75.59 64 8.53 8.9 9.45 6.47
  🟢 +0.53 🟢 +0 🟢 +0.1 🟢 +0.1 🟢 +0.06 🟢 +0.04
GelatoRelayPack.md 69.88 50.02 8.39 8.9 10.48 7.15
  - - - - - -
README.md 80.06 74.19 8.2 7.5 8.11 7
  🔴 -19.94 🔴 -25.81 🔴 -2.2 🔴 -1.5 🔴 -2.11 🔴 -2.1
RelayKitBasePack.md 70.74 59.4 8.32 8.5 10.6 7.53
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 70.16 61.08 9.15 9.48 10.32 7.03
  🔴 -0.36 🔴 -0.73 🔴 -0.01 🟢 +0 🔴 -0.05 🔴 -0.05
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 Dec 27 '23 15:12 github-actions[bot]

Closed as the Gelato Relay Reference (not working with the ERC-4337 in the way it is integrated in the SDK) is not a priority. Gelato Relay Reference will be rechecked once/if the SDK integrates the ERC-4337 Gelato implementation.

germartinez avatar May 27 '24 15:05 germartinez