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 Tx Service data decoder guide #489

Merged
merged 8 commits into from
Jun 5, 2024

Conversation

falvaradorodriguez
Copy link
Contributor

Copy link

github-actions bot commented May 29, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented May 29, 2024

Overall readability score: 55.48 (🔴 -0.42)

File Readability
api-safe-transaction-service.mdx 50.63 (🔴 -0.2)
data-decoder.mdx 21.63 (-)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
api-safe-transaction-service.mdx 50.63 38.21 9.83 14.5 15.25 7.14
  🔴 -0.2 🔴 -0.41 🔴 -0.07 🔴 -0.1 🟢 +0 🟢 +0.04
data-decoder.mdx 21.63 26 12.98 22 19 8.82
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.48 48.73 10.88 12.81 12.43 7.61
  🔴 -0.42 🔴 -0.29 🔴 -0.03 🔴 -0.11 🔴 -0.08 🔴 -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

Copy link
Member

@Uxio0 Uxio0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me @tanay1337 could you review?

@falvaradorodriguez
Copy link
Contributor Author

Looks good to me @tanay1337 could you review?

@Uxio0 I have added the part of safe-eth-py that is incorporated in this task: safe-global/safe-eth-py#1006

Copy link
Member

@Uxio0 Uxio0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome

Copy link
Collaborator

@tanay1337 tanay1337 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor updates, thanks!

pages/core-api/api-safe-transaction-service.mdx Outdated Show resolved Hide resolved
pages/core-api/transaction-service-guides/data-decoder.mdx Outdated Show resolved Hide resolved
pages/core-api/transaction-service-guides/data-decoder.mdx Outdated Show resolved Hide resolved
pages/core-api/transaction-service-guides/data-decoder.mdx Outdated Show resolved Hide resolved
@tanay1337 tanay1337 self-requested a review June 5, 2024 12:03
@falvaradorodriguez falvaradorodriguez merged commit 147742c into main Jun 5, 2024
4 checks passed
@tanay1337 tanay1337 deleted the add_data_decoder_guide branch June 5, 2024 13:17
@falvaradorodriguez falvaradorodriguez restored the add_data_decoder_guide branch July 5, 2024 11:17
@falvaradorodriguez falvaradorodriguez deleted the add_data_decoder_guide branch July 5, 2024 11:17
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.

Refactor Tx Service page in safe docs
3 participants