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: Safe Smart Account docs improvements #653

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

akshay-ap
Copy link
Member

Fixes https://github.com/safe-global/developer-experience/issues/243

Changes in PR-

  • Improve Overview page for Safe Smart Account

@akshay-ap akshay-ap self-assigned this Dec 2, 2024
@akshay-ap akshay-ap marked this pull request as draft December 2, 2024 16:11
Copy link

github-actions bot commented Dec 2, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Dec 2, 2024

Overall readability score: 30.81 (🔴 -0.6)

File Readability
smart-account-overview.mdx 63.99 (🟢 +41.15)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
smart-account-overview.mdx 63.99 46.17 9.18 11.6 12.06 6.45
  🟢 +41.15 🟢 +12.63 🟢 +5.17 🟢 +8.6 🟢 +6.45 🟢 +2.68

Averages:

  Readability FRE GF ARI CLI DCRS
Average 30.81 26.78 13.65 17.76 15.81 8.96
  🔴 -0.6 🔴 -0.58 🟢 +0.04 🔴 -0.36 🔴 -0.08 🟢 +0.02
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

@akshay-ap akshay-ap force-pushed the feature-smart-contract-docs branch from c532a64 to 5a87610 Compare December 2, 2024 16:12
@akshay-ap akshay-ap requested a review from germartinez December 3, 2024 13:18
@akshay-ap akshay-ap marked this pull request as ready for review December 3, 2024 13:18
@germartinez germartinez changed the title Contract docs improvements docs: Contract docs improvements Dec 4, 2024
@germartinez germartinez changed the title docs: Contract docs improvements docs: Safe Smart Account docs improvements Dec 4, 2024
@germartinez
Copy link
Member

I updated the style of the diagrams.
Can we use this version instead?

Screenshot 2024-12-04 at 16 23 39

Screenshot 2024-12-04 at 16 01 09

Screenshot 2024-12-04 at 16 01 58

Screenshot 2024-12-04 at 16 24 51

@akshay-ap akshay-ap force-pushed the feature-smart-contract-docs branch from 8840e76 to 776dfcd Compare December 6, 2024 10:44
@akshay-ap akshay-ap requested a review from germartinez December 6, 2024 11:24
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