safe-docs icon indicating copy to clipboard operation
safe-docs copied to clipboard

docs: Add Starter Kit reference

Open yagopv opened this issue 1 year ago • 2 comments

Context

This PR:

  • Creates a new reference for the Starter Kit

yagopv avatar Aug 30 '24 13:08 yagopv

Branch preview

✅ Deployed successfully in branch deployment:

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

github-actions[bot] avatar Aug 30 '24 13:08 github-actions[bot]

Overall readability score: 38.85 (🔴 -3.64)

File Readability
data-decoder.mdx 21.63 (🟢 +0)
removesafedelegate.mdx 8.51 (🟢 +0)
offchain-messages.mdx 3.27 (-)
confirmoffchainmessage.mdx 13.3 (-)
getpendingoffchainmessages.mdx 0 (-)
sendoffchainmessage.mdx 32.4 (-)
onchain-messages.mdx 0 (-)
sendonchainmessage.mdx 58.7 (-)
overview.mdx 56.4 (-)
safe-client-result.mdx 63.92 (-)
confirm.mdx 13.82 (-)
constructor.mdx 56.98 (-)
createaddownertransaction.mdx 33.98 (-)
createchangethresholdtransaction.mdx 21.99 (-)
createremoveownertransaction.mdx 30.42 (-)
createswapownertransaction.mdx 28.1 (-)
extend.mdx 18.13 (-)
getaddress.mdx 1.22 (-)
getnonce.mdx 0.32 (-)
getowners.mdx 2.92 (-)
getownerswhoapprovedtx.mdx 16.81 (-)
getpendingtransactions.mdx 0 (-)
getthreshold.mdx 0.32 (-)
isdeployed.mdx 0 (-)
isowner.mdx 18.72 (-)
send.mdx 67.29 (-)
safe-operations.mdx 31.37 (-)
confirmsafeoperation.mdx 8.88 (-)
getpendingsafeoperations.mdx 0 (-)
sendsafeoperation.mdx 50.04 (-)
migrate-to-v3.md 71.32 (🟢 +0)
migrate-to-v3.md 63.48 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
data-decoder.mdx 21.63 26 12.98 22 19 8.82
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
removesafedelegate.mdx 8.51 0 16.21 22 19 9.84
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
offchain-messages.mdx 3.27 0 17.15 22 19 10.97
  - - - - - -
confirmoffchainmessage.mdx 13.3 19.4 16.6 22 19 9.14
  - - - - - -
getpendingoffchainmessages.mdx 0 0 19 22 19 11
  - - - - - -
sendoffchainmessage.mdx 32.4 40.28 12.89 20.2 15.61 8.55
  - - - - - -
onchain-messages.mdx 0 0 19 22 19 11
  - - - - - -
sendonchainmessage.mdx 58.7 53.37 8.27 13 13.13 7.85
  - - - - - -
overview.mdx 56.4 62.38 10 16.2 12.53 6.92
  - - - - - -
safe-client-result.mdx 63.92 46.03 7.8 10.3 13.42 7.19
  - - - - - -
confirm.mdx 13.82 19.4 16.6 22 18.63 9.14
  - - - - - -
constructor.mdx 56.98 51.44 9.81 12.3 12.51 8.05
  - - - - - -
createaddownertransaction.mdx 33.98 37.81 10.84 20.9 16.59 8.28
  - - - - - -
createchangethresholdtransaction.mdx 21.99 26.1 12.63 22 19 8.9
  - - - - - -
createremoveownertransaction.mdx 30.42 29.35 10.84 21.6 17.4 8.28
  - - - - - -
createswapownertransaction.mdx 28.1 26.51 11.86 22 17.4 8.13
  - - - - - -
extend.mdx 18.13 0 11.76 22 19 9.22
  - - - - - -
getaddress.mdx 1.22 0 19 22 19 10.62
  - - - - - -
getnonce.mdx 0.32 0 19 22 19 10.9
  - - - - - -
getowners.mdx 2.92 0 19 22 19 10.09
  - - - - - -
getownerswhoapprovedtx.mdx 16.81 12.77 14.7 22 19 8.72
  - - - - - -
getpendingtransactions.mdx 0 0 19 22 19 11
  - - - - - -
getthreshold.mdx 0.32 0 19 22 19 10.9
  - - - - - -
isdeployed.mdx 0 0 19 22 19 11
  - - - - - -
isowner.mdx 18.72 15.14 16.13 22 16.66 8.51
  - - - - - -
send.mdx 67.29 60.11 7.86 11.2 11.52 7.26
  - - - - - -
safe-operations.mdx 31.37 23.22 11.62 18.4 17.22 8.78
  - - - - - -
confirmsafeoperation.mdx 8.88 10.94 17.61 22 19 9.54
  - - - - - -
getpendingsafeoperations.mdx 0 0 19 22 19 11
  - - - - - -
sendsafeoperation.mdx 50.04 40.35 9.56 14.6 14.43 7.89
  - - - - - -
migrate-to-v3.md 71.32 65.73 10.74 7.7 8.4 7.71
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v3.md 63.48 48.91 11.33 8.9 9.97 7.74
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 38.85 34.12 12.5 16.54 14.89 8.41
  🔴 -3.64 🔴 -3.02 🔴 -0.44 🔴 -0.73 🔴 -0.52 🔴 -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

github-actions[bot] avatar Aug 30 '24 13:08 github-actions[bot]