safe-global / safe-docs

Developer Docs for building on Safe.
https://docs.safe.global
MIT License
51 stars 70 forks source link

docs: Add SDK Starter Kit #604

Closed germartinez closed 4 days ago

germartinez commented 1 week ago

This PR:

Adds:

Additionally adds:

github-actions[bot] commented 1 week ago

Branch preview

✅ Deployed successfully in branch deployment:

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

github-actions[bot] commented 1 week ago

Overall readability score: 38.79 (🔴 -3.79)

File Readability
data-decoder.mdx 21.63 (🟢 +0)
delegates.mdx 14.71 (🟢 +0)
messages.mdx 8.19 (🟢 +0)
transactions.mdx 8.92 (🟢 +0)
proposetransaction.mdx 38.69 (🟢 +0.84)
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 (-)
getownerswhoapprovedtransaction.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 (-)
propose-and-confirm-transactions.mdx 63.1 (🟢 +0)
overview.mdx 45.42 (🟢 +5.16)
protocol-kit.mdx 32.96 (🔴 -34.55)
execute-transactions.mdx 69.23 (-)
migrate-to-v3.md 71.32 (🟢 +0)
migrate-to-v4.md 68.79 (🟢 +0)
reference.md 79.23 (🟢 +0)
safe.mdx 71.69 (🔴 -0.42)
relay-kit.mdx 49.59 (🟢 +0)
4337-safe-sdk.mdx 36.55 (🟢 +1.19)
gelato-relay.mdx 66.67 (🟢 +0)
migrate-to-v3.md 63.48 (🟢 +0)
starter-kit.mdx 52.24 (-)
send-transactions.mdx 28.23 (-)
send-user-operations.mdx 28.33 (-)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [data-decoder.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/core-api/transaction-service-guides/data-decoder.mdx "pages/core-api/transaction-service-guides/data-decoder.mdx") | 21.63 | 26 | 12.98 | 22 | 19 | 8.82   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [delegates.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/core-api/transaction-service-guides/delegates.mdx "pages/core-api/transaction-service-guides/delegates.mdx") | 14.71 | 1.63 | 14.25 | 22 | 19 | 9.04   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [messages.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/core-api/transaction-service-guides/messages.mdx "pages/core-api/transaction-service-guides/messages.mdx") | 8.19 | 0 | 18.57 | 22 | 19 | 8.68   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [transactions.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/core-api/transaction-service-guides/transactions.mdx "pages/core-api/transaction-service-guides/transactions.mdx") | 8.92 | 0 | 18.8 | 22 | 19 | 8.33   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [proposetransaction.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-api-kit/proposetransaction.mdx "pages/reference-sdk-api-kit/proposetransaction.mdx") | 38.69 | 25.56 | 9.24 | 18 | 18.43 | 7.54   | 🟢 +0.84 | 🟢 +0 | 🟢 +0 | 🟢 +0.3 | 🟢 +0.29 | 🟢 +0 [removesafedelegate.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-api-kit/removesafedelegate.mdx "pages/reference-sdk-api-kit/removesafedelegate.mdx") | 8.51 | 0 | 16.21 | 22 | 19 | 9.84   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [offchain-messages.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/offchain-messages.mdx "pages/reference-sdk-starter-kit/offchain-messages.mdx") | 3.27 | 0 | 17.15 | 22 | 19 | 10.97   | - | - | - | - | - | - [confirmoffchainmessage.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/offchain-messages/confirmoffchainmessage.mdx "pages/reference-sdk-starter-kit/offchain-messages/confirmoffchainmessage.mdx") | 13.3 | 19.4 | 16.6 | 22 | 19 | 9.14   | - | - | - | - | - | - [getpendingoffchainmessages.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/offchain-messages/getpendingoffchainmessages.mdx "pages/reference-sdk-starter-kit/offchain-messages/getpendingoffchainmessages.mdx") | 0 | 0 | 19 | 22 | 19 | 11   | - | - | - | - | - | - [sendoffchainmessage.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/offchain-messages/sendoffchainmessage.mdx "pages/reference-sdk-starter-kit/offchain-messages/sendoffchainmessage.mdx") | 32.4 | 40.28 | 12.89 | 20.2 | 15.61 | 8.55   | - | - | - | - | - | - [onchain-messages.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/onchain-messages.mdx "pages/reference-sdk-starter-kit/onchain-messages.mdx") | 0 | 0 | 19 | 22 | 19 | 11   | - | - | - | - | - | - [sendonchainmessage.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/onchain-messages/sendonchainmessage.mdx "pages/reference-sdk-starter-kit/onchain-messages/sendonchainmessage.mdx") | 58.7 | 53.37 | 8.27 | 13 | 13.13 | 7.85   | - | - | - | - | - | - [overview.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/overview.mdx "pages/reference-sdk-starter-kit/overview.mdx") | 56.4 | 62.38 | 10 | 16.2 | 12.53 | 6.92   | - | - | - | - | - | - [safe-client-result.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client-result.mdx "pages/reference-sdk-starter-kit/safe-client-result.mdx") | 63.92 | 46.03 | 7.8 | 10.3 | 13.42 | 7.19   | - | - | - | - | - | - [confirm.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/confirm.mdx "pages/reference-sdk-starter-kit/safe-client/confirm.mdx") | 13.82 | 19.4 | 16.6 | 22 | 18.63 | 9.14   | - | - | - | - | - | - [constructor.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/constructor.mdx "pages/reference-sdk-starter-kit/safe-client/constructor.mdx") | 56.98 | 51.44 | 9.81 | 12.3 | 12.51 | 8.05   | - | - | - | - | - | - [createaddownertransaction.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/createaddownertransaction.mdx "pages/reference-sdk-starter-kit/safe-client/createaddownertransaction.mdx") | 33.98 | 37.81 | 10.84 | 20.9 | 16.59 | 8.28   | - | - | - | - | - | - [createchangethresholdtransaction.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/createchangethresholdtransaction.mdx "pages/reference-sdk-starter-kit/safe-client/createchangethresholdtransaction.mdx") | 21.99 | 26.1 | 12.63 | 22 | 19 | 8.9   | - | - | - | - | - | - [createremoveownertransaction.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/createremoveownertransaction.mdx "pages/reference-sdk-starter-kit/safe-client/createremoveownertransaction.mdx") | 30.42 | 29.35 | 10.84 | 21.6 | 17.4 | 8.28   | - | - | - | - | - | - [createswapownertransaction.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/createswapownertransaction.mdx "pages/reference-sdk-starter-kit/safe-client/createswapownertransaction.mdx") | 28.1 | 26.51 | 11.86 | 22 | 17.4 | 8.13   | - | - | - | - | - | - [extend.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/extend.mdx "pages/reference-sdk-starter-kit/safe-client/extend.mdx") | 18.13 | 0 | 11.76 | 22 | 19 | 9.22   | - | - | - | - | - | - [getaddress.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/getaddress.mdx "pages/reference-sdk-starter-kit/safe-client/getaddress.mdx") | 1.22 | 0 | 19 | 22 | 19 | 10.62   | - | - | - | - | - | - [getnonce.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/getnonce.mdx "pages/reference-sdk-starter-kit/safe-client/getnonce.mdx") | 0.32 | 0 | 19 | 22 | 19 | 10.9   | - | - | - | - | - | - [getowners.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/getowners.mdx "pages/reference-sdk-starter-kit/safe-client/getowners.mdx") | 2.92 | 0 | 19 | 22 | 19 | 10.09   | - | - | - | - | - | - [getownerswhoapprovedtransaction.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/getownerswhoapprovedtransaction.mdx "pages/reference-sdk-starter-kit/safe-client/getownerswhoapprovedtransaction.mdx") | 16.81 | 12.77 | 14.7 | 22 | 19 | 8.72   | - | - | - | - | - | - [getpendingtransactions.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/getpendingtransactions.mdx "pages/reference-sdk-starter-kit/safe-client/getpendingtransactions.mdx") | 0 | 0 | 19 | 22 | 19 | 11   | - | - | - | - | - | - [getthreshold.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/getthreshold.mdx "pages/reference-sdk-starter-kit/safe-client/getthreshold.mdx") | 0.32 | 0 | 19 | 22 | 19 | 10.9   | - | - | - | - | - | - [isdeployed.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/isdeployed.mdx "pages/reference-sdk-starter-kit/safe-client/isdeployed.mdx") | 0 | 0 | 19 | 22 | 19 | 11   | - | - | - | - | - | - [isowner.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/isowner.mdx "pages/reference-sdk-starter-kit/safe-client/isowner.mdx") | 18.72 | 15.14 | 16.13 | 22 | 16.66 | 8.51   | - | - | - | - | - | - [send.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-client/send.mdx "pages/reference-sdk-starter-kit/safe-client/send.mdx") | 67.29 | 60.11 | 7.86 | 11.2 | 11.52 | 7.26   | - | - | - | - | - | - [safe-operations.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-operations.mdx "pages/reference-sdk-starter-kit/safe-operations.mdx") | 31.37 | 23.22 | 11.62 | 18.4 | 17.22 | 8.78   | - | - | - | - | - | - [confirmsafeoperation.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-operations/confirmsafeoperation.mdx "pages/reference-sdk-starter-kit/safe-operations/confirmsafeoperation.mdx") | 8.88 | 10.94 | 17.61 | 22 | 19 | 9.54   | - | - | - | - | - | - [getpendingsafeoperations.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-operations/getpendingsafeoperations.mdx "pages/reference-sdk-starter-kit/safe-operations/getpendingsafeoperations.mdx") | 0 | 0 | 19 | 22 | 19 | 11   | - | - | - | - | - | - [sendsafeoperation.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/reference-sdk-starter-kit/safe-operations/sendsafeoperation.mdx "pages/reference-sdk-starter-kit/safe-operations/sendsafeoperation.mdx") | 50.04 | 40.35 | 9.56 | 14.6 | 14.43 | 7.89   | - | - | - | - | - | - [propose-and-confirm-transactions.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/api-kit/guides/propose-and-confirm-transactions.mdx "pages/sdk/api-kit/guides/propose-and-confirm-transactions.mdx") | 63.1 | 54.93 | 11.03 | 10.2 | 10.61 | 7.46   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [overview.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/overview.mdx "pages/sdk/overview.mdx") | 45.42 | 41.16 | 10.66 | 14.8 | 15.99 | 8.01   | 🟢 +5.16 | 🟢 +7.55 | 🟢 +0.31 | 🟢 +0.7 | 🟢 +1.11 | 🟢 +0.25 [protocol-kit.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/protocol-kit.mdx "pages/sdk/protocol-kit.mdx") | 32.96 | 37.5 | 15.08 | 15 | 15.08 | 9.65   | 🔴 -34.55 | 🔴 -19.87 | 🔴 -5.83 | 🔴 -5 | 🔴 -3.6 | 🔴 -2.78 [execute-transactions.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/protocol-kit/guides/execute-transactions.mdx "pages/sdk/protocol-kit/guides/execute-transactions.mdx") | 69.23 | 57.06 | 9.15 | 9.8 | 10.78 | 6.77   | - | - | - | - | - | - [migrate-to-v3.md](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/protocol-kit/guides/migrate-to-v3.md "pages/sdk/protocol-kit/guides/migrate-to-v3.md") | 71.32 | 65.73 | 10.74 | 7.7 | 8.4 | 7.71   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [migrate-to-v4.md](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/protocol-kit/guides/migrate-to-v4.md "pages/sdk/protocol-kit/guides/migrate-to-v4.md") | 68.79 | 57.87 | 9.66 | 9 | 10.32 | 7.24   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [reference.md](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/protocol-kit/reference.md "pages/sdk/protocol-kit/reference.md") | 79.23 | 69.48 | 7.99 | 7.3 | 9.31 | 6.69   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [safe.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/protocol-kit/reference/safe.mdx "pages/sdk/protocol-kit/reference/safe.mdx") | 71.69 | 50.43 | 7.29 | 10.4 | 12.11 | 5.8   | 🔴 -0.42 | 🔴 -0.3 | 🔴 -0.21 | 🟢 +0 | 🟢 +0.11 | 🔴 -0.05 [relay-kit.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/relay-kit.mdx "pages/sdk/relay-kit.mdx") | 49.59 | 53.41 | 11.63 | 13.7 | 12.76 | 8.74   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [4337-safe-sdk.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/relay-kit/guides/4337-safe-sdk.mdx "pages/sdk/relay-kit/guides/4337-safe-sdk.mdx") | 36.55 | 39.2 | 16.21 | 19.4 | 11.33 | 7.67   | 🟢 +1.19 | 🔴 -6.43 | 🟢 +0.72 | 🟢 +0.8 | 🔴 -0.24 | 🟢 +0.06 [gelato-relay.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/relay-kit/guides/gelato-relay.mdx "pages/sdk/relay-kit/guides/gelato-relay.mdx") | 66.67 | 54.42 | 9.56 | 10.5 | 10.79 | 6.89   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [migrate-to-v3.md](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/relay-kit/guides/migrate-to-v3.md "pages/sdk/relay-kit/guides/migrate-to-v3.md") | 63.48 | 48.91 | 11.33 | 8.9 | 9.97 | 7.74   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [starter-kit.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/starter-kit.mdx "pages/sdk/starter-kit.mdx") | 52.24 | 46.47 | 11.83 | 12.8 | 12.82 | 7.83   | - | - | - | - | - | - [send-transactions.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/starter-kit/guides/send-transactions.mdx "pages/sdk/starter-kit/guides/send-transactions.mdx") | 28.23 | 42.68 | 17.79 | 22 | 11.79 | 8.22   | - | - | - | - | - | - [send-user-operations.mdx](https://github.com/safe-global/safe-docs/blob/f467e0cb8b56011fa2b7fd2b42f575ffa170d946/pages/sdk/starter-kit/guides/send-user-operations.mdx "pages/sdk/starter-kit/guides/send-user-operations.mdx") | 28.33 | 35.65 | 17.52 | 21.9 | 11.44 | 8.17   | - | - | - | - | - | - Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 38.79 | 34.25 | 12.56 | 16.57 | 14.83 | 8.41   | 🔴 -3.79 | 🔴 -3.03 | 🔴 -0.5 | 🔴 -0.76 | 🔴 -0.5 | 🔴 -0.2
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