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 Safe smart account reference #624

Merged
merged 67 commits into from
Nov 21, 2024
Merged

Conversation

louis-md
Copy link
Collaborator

Copy link

github-actions bot commented Oct 18, 2024

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Oct 18, 2024

Overall readability score: 30.84 (🔴 -0.34)

File Readability
ModuleCallout.mdx 12.68 (-)
OnlySafeTxCallout.mdx 12.68 (-)
AddedOwner.mdx 84.43 (-)
ApproveHash.mdx 84.43 (-)
ChangedFallbackHandler.mdx 57.68 (-)
ChangedGuard.mdx 92.85 (-)
ChangedModuleGuard.mdx 86.69 (-)
ChangedThreshold.mdx 39.88 (-)
DisabledModule.mdx 68.26 (-)
EnabledModule.mdx 68.34 (-)
ExecutionFailure.mdx 40.9 (-)
ExecutionFromModuleFailure.mdx 42.31 (-)
ExecutionFromModuleSuccess.mdx 35.88 (-)
ExecutionSuccess.mdx 13.25 (-)
RemovedOwner.mdx 89.97 (-)
SafeReceived.mdx 68.8 (-)
SafeSetup.mdx 89.7 (-)
SignMsg.mdx 90.05 (-)
fallback.mdx 0 (-)
receive.mdx 0 (-)
setFallbackHandler.mdx 0 (-)
setGuard.mdx 0 (-)
setModuleGuard.mdx 0 (-)
disableModule.mdx 0.29 (-)
enableModule.mdx 0 (-)
execTransactionFromModule.mdx 9.58 (-)
execTransactionFromModuleReturnData.mdx 10.29 (-)
getModulesPaginated.mdx 60.79 (-)
isModuleEnabled.mdx 5.39 (-)
overview.mdx 32.76 (-)
addOwnerWithThreshold.mdx 0 (-)
changeThreshold.mdx 0 (-)
getOwners.mdx 0.29 (-)
getThreshold.mdx 0.46 (-)
isOwner.mdx 3 (-)
removeOwner.mdx 1.67 (-)
swapOwner.mdx 6.05 (-)
domainSeparator.mdx 0 (-)
setup.mdx 4.7 (-)
approveHash.mdx 0 (-)
checkNSignatures.mdx 18.47 (-)
checkSignatures.mdx 16.87 (-)
signedMessages.mdx 13.2 (-)
encodeTransactionData.mdx 24.46 (-)
execTransaction.mdx 25.93 (-)
getTransactionHash.mdx 31.55 (-)
simulateAndRevert.mdx 23.64 (-)
getStorageAt.mdx 32.99 (-)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
ModuleCallout.mdx 12.68 0 11.6 22 19 11
  - - - - - -
OnlySafeTxCallout.mdx 12.68 0 11.6 22 19 11
  - - - - - -
AddedOwner.mdx 84.43 79.26 8.04 6 6 7.59
  - - - - - -
ApproveHash.mdx 84.43 79.26 8.04 6 6 7.59
  - - - - - -
ChangedFallbackHandler.mdx 57.68 64.37 8.51 9 12.36 10.75
  - - - - - -
ChangedGuard.mdx 92.85 96.18 8.04 6 6 5.84
  - - - - - -
ChangedModuleGuard.mdx 86.69 86.71 8 6 6 7.29
  - - - - - -
ChangedThreshold.mdx 39.88 46.44 13.2 12 15.91 9.95
  - - - - - -
DisabledModule.mdx 68.26 62.34 12.49 6 6.06 9.35
  - - - - - -
EnabledModule.mdx 68.34 62.34 12.49 6 6 9.35
  - - - - - -
ExecutionFailure.mdx 40.9 49.48 18 9.3 11.92 10.2
  - - - - - -
ExecutionFromModuleFailure.mdx 42.31 36.96 16.93 7.7 10.58 11
  - - - - - -
ExecutionFromModuleSuccess.mdx 35.88 28.5 16.93 9.3 12.5 11
  - - - - - -
ExecutionSuccess.mdx 13.25 0 19 13.7 18.16 11
  - - - - - -
RemovedOwner.mdx 89.97 79.26 8.04 6 6.06 5.84
  - - - - - -
SafeReceived.mdx 68.8 63.36 8.2 8.5 11.56 7.98
  - - - - - -
SafeSetup.mdx 89.7 89.75 8.51 6 6 6.24
  - - - - - -
SignMsg.mdx 90.05 79.26 8.04 6 6 5.84
  - - - - - -
fallback.mdx 0 0 19 22 19 11
  - - - - - -
receive.mdx 0 0 19 22 19 11
  - - - - - -
setFallbackHandler.mdx 0 0 19 22 19 11
  - - - - - -
setGuard.mdx 0 0 19 22 19 11
  - - - - - -
setModuleGuard.mdx 0 0 19 22 19 11
  - - - - - -
disableModule.mdx 0.29 0 18.83 22 19 11
  - - - - - -
enableModule.mdx 0 0 19 22 19 11
  - - - - - -
execTransactionFromModule.mdx 9.58 0 13.41 22 19 11
  - - - - - -
execTransactionFromModuleReturnData.mdx 10.29 0 13.56 22 19 10.7
  - - - - - -
getModulesPaginated.mdx 60.79 51.34 8.08 12.6 11.75 7.98
  - - - - - -
isModuleEnabled.mdx 5.39 2.44 16.09 22 19 11
  - - - - - -
overview.mdx 32.76 45.76 11.51 15.6 16.88 10.98
  - - - - - -
addOwnerWithThreshold.mdx 0 0 19 22 19 11
  - - - - - -
changeThreshold.mdx 0 0 19 22 19 11
  - - - - - -
getOwners.mdx 0.29 1.77 19 22 19 11
  - - - - - -
getThreshold.mdx 0.46 2.79 19 22 19 11
  - - - - - -
isOwner.mdx 3 7.53 19 22 17.94 10.92
  - - - - - -
removeOwner.mdx 1.67 0 19 22 19 10.48
  - - - - - -
swapOwner.mdx 6.05 0 16.65 22 19 10.37
  - - - - - -
domainSeparator.mdx 0 0 19 22 19 11
  - - - - - -
setup.mdx 4.7 7.35 16.97 22 19 11
  - - - - - -
approveHash.mdx 0 0 19 22 19 11
  - - - - - -
checkNSignatures.mdx 18.47 24.44 13.41 20.1 19 10.35
  - - - - - -
checkSignatures.mdx 16.87 29.86 14.53 20.6 18.33 10.6
  - - - - - -
signedMessages.mdx 13.2 22.75 16.16 22 19 9.58
  - - - - - -
encodeTransactionData.mdx 24.46 30.87 12.86 19.2 18.38 9.79
  - - - - - -
execTransaction.mdx 25.93 23.93 12.31 18.8 19 9.18
  - - - - - -
getTransactionHash.mdx 31.55 37.71 12.5 18.2 17.22 9.09
  - - - - - -
simulateAndRevert.mdx 23.64 24.03 13.72 17.1 16.52 11
  - - - - - -
getStorageAt.mdx 32.99 50.16 12.84 19.8 15.37 9.19
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 30.84 26.86 13.64 17.73 15.82 8.97
  🔴 -0.34 🟢 +0.33 🔴 -0.17 🟢 +0.26 🟢 +0.1 🔴 -0.19
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 changed the title feat: Smart account reference docs: Add Safe smart account reference Oct 22, 2024
pages/reference-smart-account/owners/changeThreshold.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/setup/setup.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/owners/changeThreshold.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/owners/getThreshold.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/owners/getThreshold.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/owners/removeOwner.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/owners/swapOwner.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/setup/setup.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/guards/setGuard.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/owners/removeOwner.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/setup/domainSeparator.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/owners/removeOwner.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/owners/removeOwner.mdx Outdated Show resolved Hide resolved
pages/reference-smart-account/utilities/getStorageAt.mdx Outdated Show resolved Hide resolved
redirects.json Outdated
@@ -843,5 +843,35 @@
"source": "/advanced/passkeys/supported-networks",
"destination": "/advanced/smart-account-supported-networks?module=Safe+Passkey+Module",
"permanent": true
},
Copy link
Collaborator

Choose a reason for hiding this comment

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

I agree with Germán here for the reasons he mentioned in his last comment.

louis-md and others added 15 commits November 20, 2024 10:39
@tanay1337 tanay1337 self-requested a review November 21, 2024 13:45
@louis-md louis-md merged commit b38f3f6 into main Nov 21, 2024
4 checks passed
@louis-md louis-md deleted the smart-account-reference branch November 21, 2024 14:04
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.

3 participants