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 React Hooks guide #621

Merged
merged 7 commits into from
Oct 17, 2024
Merged

docs: Add React Hooks guide #621

merged 7 commits into from
Oct 17, 2024

Conversation

germartinez
Copy link
Member

Context

This PR:

  • Adds a guide to show the transaction flow with the Safe React Hooks.

Copy link

github-actions bot commented Oct 17, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Oct 17, 2024

Overall readability score: 38.31 (🔴 -0.06)

File Readability
usesafe.mdx 0 (🟢 +0)
getbalance.mdx 67.12 (🟢 +0)
getpendingtransactions.mdx 67.25 (🟢 +0)
getsafeinfo.mdx 67.52 (🟢 +0)
getsigneraddress.mdx 2.62 (🟢 +0)
gettransactions.mdx 67.37 (🟢 +0)
api-kit.mdx 31.74 (🟢 +0)
protocol-kit.mdx 32.96 (🟢 +0)
react-hooks.mdx 44.12 (-)
send-transactions.mdx 20.91 (-)
relay-kit.mdx 46.54 (🟢 +0)
starter-kit.mdx 52.24 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
usesafe.mdx 0 0 19 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
getbalance.mdx 67.12 58.69 8.21 11.4 11.3 7.06
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
getpendingtransactions.mdx 67.25 58.48 8.34 11.3 11.24 7.01
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
getsafeinfo.mdx 67.52 58.58 8.23 11.3 11.24 6.99
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
getsigneraddress.mdx 2.62 0 18.95 22 19 10.21
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
gettransactions.mdx 67.37 58.58 8.31 11.3 11.18 7.02
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
api-kit.mdx 31.74 32.73 14.18 17.2 15.03 9.29
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
protocol-kit.mdx 32.96 37.5 15.08 15 15.08 9.65
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
react-hooks.mdx 44.12 39.67 12.68 15.6 13 8.21
  - - - - - -
send-transactions.mdx 20.91 26.17 18.23 22 14.81 8.09
  - - - - - -
relay-kit.mdx 46.54 53.21 12.2 14.2 13.28 8.92
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
starter-kit.mdx 52.24 46.47 11.83 12.8 12.82 7.83
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 38.31 33.55 12.55 16.69 14.94 8.43
  🔴 -0.06 🔴 -0.01 🔴 -0.03 🔴 -0.02 🟢 +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

@germartinez germartinez merged commit 660fc62 into development Oct 17, 2024
3 checks passed
@germartinez germartinez deleted the react-hooks-guide branch October 17, 2024 13:49
germartinez added a commit that referenced this pull request Oct 17, 2024
* Add send transactions guide

* Fix titles in the reference

* Small fixes/typos

* Fix installation

* Add hooks home page

* Adjust styles

* Update SDK sidebar
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