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: Introduce types-kit #590

Merged
merged 4 commits into from
Sep 24, 2024
Merged

docs: Introduce types-kit #590

merged 4 commits into from
Sep 24, 2024

Conversation

yagopv
Copy link
Member

@yagopv yagopv commented Sep 17, 2024

⚠️ Don't merge until the new package is published ⚠️

This PR resolves safe-global/safe-core-sdk#947

We are renaming the package safe-cores-sdk-types to types-kit

Copy link

github-actions bot commented Sep 17, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Sep 17, 2024

Overall readability score: 42.49 (🟢 +0.01)

File Readability
delegates.mdx 14.71 (🟢 +0)
messages.mdx 8.19 (🟢 +0)
transactions.mdx 8.92 (🟢 +0)
proposetransaction.mdx 38.69 (🟢 +0.84)
propose-and-confirm-transactions.mdx 63.1 (🟢 +0)
protocol-kit.mdx 67.51 (🟢 +0)
migrate-to-v4.md 68.79 (🟢 +0)
gelato-relay.mdx 66.67 (🟢 +0)
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
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
messages.mdx 8.19 0 18.57 22 19 8.68
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
transactions.mdx 8.92 0 18.8 22 19 8.33
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
proposetransaction.mdx 38.69 25.56 9.24 18 18.43 7.54
  🟢 +0.84 🟢 +0 🟢 +0 🟢 +0.3 🟢 +0.29 🟢 +0
propose-and-confirm-transactions.mdx 63.1 54.93 11.03 10.2 10.61 7.46
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
protocol-kit.mdx 67.51 57.37 9.25 10 11.48 6.87
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v4.md 68.79 57.87 9.66 9 10.32 7.24
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
gelato-relay.mdx 66.67 54.42 9.56 10.5 10.79 6.89
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 42.49 37.14 12.06 15.81 14.37 8.22
  🟢 +0.01 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +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

@yagopv
Copy link
Member Author

yagopv commented Sep 17, 2024

@dasanra i did not update migration guides. Perhaps the migration-to-v4 could be updated to

Note: When upgrading to protocol-kit v4, it's necessary to upgrade to types-kit v1

wdyt?

@dasanra
Copy link
Contributor

dasanra commented Sep 17, 2024

@yagopv something we can consider. The last major should be compatible with all the previous protocol-kit v4

@germartinez germartinez changed the title feat(safe-core-sdk): Rename safe-cores-sdk-types docs(safe-core-sdk): Rename safe-cores-sdk-types Sep 19, 2024
@germartinez germartinez changed the title docs(safe-core-sdk): Rename safe-cores-sdk-types docs: Introduce types-kit Sep 24, 2024
@germartinez germartinez merged commit 372817b into main Sep 24, 2024
4 checks passed
@germartinez germartinez deleted the rename-sdk-types branch September 24, 2024 14:49
germartinez added a commit that referenced this pull request Sep 25, 2024
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.

[SDK Refactor] Rename safe-core-sdk-types to types-kit
3 participants