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

Change code order to improve learners experience #673

Conversation

valle-xyz
Copy link
Collaborator

This PR suggests some changes in how code and concepts are introduced to reduce cognitive load of the learner and (hopefully) increase the learning experience.

Copy link

github-actions bot commented Jan 16, 2025

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Jan 16, 2025

Overall readability score: 31.4 (🟢 +0)

File Readability
smart-account-modules-tutorial.mdx 60.44 (🟢 +0.41)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
smart-account-modules-tutorial.mdx 60.44 43.8 8.5 10.5 13.32 7.74
  🟢 +0.41 🟢 +0.71 🔴 -0.16 🟢 +0.7 🟢 +0.41 🔴 -0.32

Averages:

  Readability FRE GF ARI CLI DCRS
Average 31.4 27.33 13.69 17.41 15.73 8.97
  🟢 +0 🟢 +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

Copy link
Member

@akshay-ap akshay-ap left a comment

Choose a reason for hiding this comment

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

LGMT! Thanks for the changes @valle-xyz !

@valle-xyz valle-xyz merged commit f52eebc into feature-safe-module-tutorial Jan 17, 2025
3 checks passed
@valle-xyz valle-xyz deleted the feature-safe-module-tutorial-suggested-changes branch January 17, 2025 11:58
akshay-ap added a commit that referenced this pull request Jan 17, 2025
* Add new tutorial for creating Safe module

* Add Enum to accept.txt

* Remove react code from smart account module tutorial

* Add content to setup Safe module tutorial

* Reorg content in Safe modules tutorial

* Add utils.ts file in Safe modules tutorial

* Add run test command in Safe module tutorial

* Add explanation for step in module tutorial

* Add comments in Solidity contract

* Add comments in empty contract in Safe module tutorial

* Update pages/advanced/smart-account-modules/smart-account-modules-tutorial.mdx

Co-authored-by: Mikhail <[email protected]>

* Update pages/advanced/smart-account-modules/smart-account-modules-tutorial.mdx

Co-authored-by: Mikhail <[email protected]>

* Update pages/advanced/smart-account-modules/smart-account-modules-tutorial.mdx

Co-authored-by: Mikhail <[email protected]>

* Update pages/advanced/smart-account-modules/smart-account-modules-tutorial.mdx

Co-authored-by: Mikhail <[email protected]>

* Update overrides and prerequisites

* Minor fixes

* Add TestToken.sol

* Code first and then explanation, move utils.ts creation step

* Consistent contract naming

* Update test code

* Remove archived repo link

* Remvoe react, and nextjs link

* Remvoe obselete statement

* Fix typo

* Add dependency

* Update license in code

* Fix minor issues in Safe Module tutorial

* Minor comment update

* Fix typo

* Change code order to improve learners experience (#673)

* add suggested changes

* correct vale error

---------

Co-authored-by: Akshay <[email protected]>

---------

Co-authored-by: Mikhail <[email protected]>
Co-authored-by: valleXYZ <[email protected]>
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