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

docs: Add reference for relay-kit #304

Closed
wants to merge 3 commits into from
Closed

Conversation

dasanra
Copy link
Contributor

@dasanra dasanra commented Dec 27, 2023

Context

This PR:

  • TBD

Copy link

github-actions bot commented Dec 27, 2023

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

@germartinez germartinez changed the title add: reference docs for relay-kit docs: reference docs for relay-kit Feb 20, 2024
@germartinez germartinez changed the title docs: reference docs for relay-kit docs: Add reference for relay-kit Feb 20, 2024
@germartinez
Copy link
Member

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 germartinez deleted the add-relay-docs branch August 22, 2024 11:42
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