docs: Refactor API Kit Reference

[germartinez]

Context

This PR:

• Refactors and improves the API Kit technical reference

[github-actions]

Overall readability score: 42.49 (🔴 -9.21)

File	Readability
addmessage.mdx	20.56 (-)
addmessagesignature.mdx	0 (-)
addsafedelegate.mdx	20.9 (-)
addsafeoperation.mdx	18.8 (-)
confirmsafeoperation.mdx	26.05 (-)
confirmtransaction.mdx	18.17 (-)
constructor.mdx	85.21 (-)
decodeddata.mdx	5.06 (-)
estimatesafetransaction.mdx	21.28 (-)
getalltransactions.mdx	23.43 (-)
getincomingtransactions.mdx	13.76 (-)
getmessage.mdx	17.04 (-)
getmessages.mdx	25.83 (-)
getmoduletransactions.mdx	13.21 (-)
getmultisigtransactions.mdx	9.24 (-)
getnextnonce.mdx	13.57 (-)
getpendingtransactions.mdx	19.98 (-)
getsafecreationinfo.mdx	10.42 (-)
getsafedelegates.mdx	29.14 (-)
getsafeinfo.mdx	8.8 (-)
getsafeoperation.mdx	12.77 (-)
getsafeoperationconfirmations.mdx	22.92 (-)
getsafeoperationsbyaddress.mdx	32.97 (-)
getsafesbymodule.mdx	12.3 (-)
getsafesbyowner.mdx	18.79 (-)
getserviceinfo.mdx	0 (-)
getservicesingletonsinfo.mdx	0 (-)
gettoken.mdx	14.02 (-)
gettokenlist.mdx	2.82 (-)
gettransaction.mdx	12.5 (-)
gettransactionconfirmations.mdx	14.03 (-)
overview.mdx	43.77 (-)
proposetransaction.mdx	37.85 (-)
removesafedelegate.mdx	8.51 (-)
api-kit.mdx	31.74 (🔴 -23.61)
propose-and-confirm-transactions.mdx	63.1 (-)
protocol-kit.mdx	67.51 (🟢 +0)
safe-4337-pack.mdx	60.46 (🔴 -0.18)

View detailed metrics

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

File	Readability	FRE	GF	ARI	CLI	DCRS
addmessage.mdx	20.56	10.77	11.27	22	19	9.28
	-	-	-	-	-	-
addmessagesignature.mdx	0	0	19	22	19	11
	-	-	-	-	-	-
addsafedelegate.mdx	20.9	8.74	10.82	22	19	9.31
	-	-	-	-	-	-
addsafeoperation.mdx	18.8	0	12.76	22	19	8.48
	-	-	-	-	-	-
confirmsafeoperation.mdx	26.05	27.83	13.31	20.5	16.01	9.35
	-	-	-	-	-	-
confirmtransaction.mdx	18.17	22.41	13.11	22	19	9.64
	-	-	-	-	-	-
constructor.mdx	85.21	78.55	6.64	7.1	6.41	7.38
	-	-	-	-	-	-
decodeddata.mdx	5.06	0	16.05	22	19	11
	-	-	-	-	-	-
estimatesafetransaction.mdx	21.28	7.72	11.87	22	19	8.58
	-	-	-	-	-	-
getalltransactions.mdx	23.43	19.37	12.09	22	18.62	8.56
	-	-	-	-	-	-
getincomingtransactions.mdx	13.76	0.92	13.95	22	19	9.46
	-	-	-	-	-	-
getmessage.mdx	17.04	12.43	12.66	22	19	9.72
	-	-	-	-	-	-
getmessages.mdx	25.83	15.57	10.73	21.8	18.9	8.31
	-	-	-	-	-	-
getmoduletransactions.mdx	13.21	7.35	14.18	22	19	9.84
	-	-	-	-	-	-
getmultisigtransactions.mdx	9.24	0	14.98	22	19	10.27
	-	-	-	-	-	-
getnextnonce.mdx	13.57	11.25	15.02	22	19	9.48
	-	-	-	-	-	-
getpendingtransactions.mdx	19.98	26.51	13.24	22	19	9.22
	-	-	-	-	-	-
getsafecreationinfo.mdx	10.42	1.43	14.97	22	19	9.98
	-	-	-	-	-	-
getsafedelegates.mdx	29.14	19.43	9.81	20.3	18.48	8.83
	-	-	-	-	-	-
getsafeinfo.mdx	8.8	0	16.04	22	19	9.84
	-	-	-	-	-	-
getsafeoperation.mdx	12.77	2.95	13.86	22	19	9.92
	-	-	-	-	-	-
getsafeoperationconfirmations.mdx	22.92	20.38	12.68	22	18.15	8.66
	-	-	-	-	-	-
getsafeoperationsbyaddress.mdx	32.97	25.25	10.36	20.1	17.56	8.14
	-	-	-	-	-	-
getsafesbymodule.mdx	12.3	12.77	15.51	22	19	9.69
	-	-	-	-	-	-
getsafesbyowner.mdx	18.79	22.24	14.51	22	18.69	8.83
	-	-	-	-	-	-
getserviceinfo.mdx	0	0	19	22	19	11
	-	-	-	-	-	-
getservicesingletonsinfo.mdx	0	0	19	22	19	11
	-	-	-	-	-	-
gettoken.mdx	14.02	8.88	14	22	19	9.76
	-	-	-	-	-	-
gettokenlist.mdx	2.82	7.53	19	22	19	10.51
	-	-	-	-	-	-
gettransaction.mdx	12.5	8.37	15.03	22	19	9.66
	-	-	-	-	-	-
gettransactionconfirmations.mdx	14.03	16.32	15.07	22	19	9.57
	-	-	-	-	-	-
overview.mdx	43.77	57.27	11.31	18.7	13.62	8.28
	-	-	-	-	-	-
proposetransaction.mdx	37.85	25.56	9.24	18.3	18.72	7.54
	-	-	-	-	-	-
removesafedelegate.mdx	8.51	0	16.21	22	19	9.84
	-	-	-	-	-	-
api-kit.mdx	31.74	32.73	14.18	17.2	15.03	9.29
	🔴 -23.61	🔴 -11.3	🔴 -2.42	🔴 -4.8	🔴 -3.25	🔴 -1.88
propose-and-confirm-transactions.mdx	63.1	54.93	11.03	10.2	10.61	7.46
	-	-	-	-	-	-
protocol-kit.mdx	67.51	57.37	9.25	10	11.48	6.87
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0
safe-4337-pack.mdx	60.46	34.02	8.13	11.7	14.2	6.5
	🔴 -0.18	🟢 +0	🟢 +0	🔴 -0.1	🟢 +0	🔴 -0.01

Averages:

	Readability	FRE	GF	ARI	CLI	DCRS
Average	42.49	37.14	12.06	15.82	14.37	8.22
	🔴 -9.21	🔴 -8.64	🔴 -0.69	🔴 -2.06	🔴 -1.47	🔴 -0.48

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]

Branch preview

✅ Deployed successfully in branch deployment:

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

[tanay1337]

Thoughts on moving the "Quickstart" section from the Overview page to the Guides section?

[valle-xyz]

Great PR!

• I (really) like that each function gets its own link in the sidebar.
• I like that every input parameter is documented.
• Discussion: I am not super sure if it increases orientation that clicking on reference opens a new sidebar view. Viem and other docs have multiple layers of tabs in the sidebar and it works. What do you guys think? Would it be possible to create a small PR with a preview of that, so we can decice?
• The return parameter is not documented yet. I would say this is out of scope, but I would like to see it implemented. Should we open a ticket for that?

[valle-xyz]

My last comments are still valid, but this looks good to me.