Improve JSDocs by adding examples of usages

[ivpavici]

Inspired by Viem docs, example:

https://viem.sh/docs/accounts/privateKey#usage

This is a big endeavor so it can be completed in multiple smaller PR-s (and more users can take it in parallel!)

[ivpavici]

Users please pick one part of the docs which you want to work on and write here for everyone else to know!

[elielnfinic]

Hey @ivpavici, could you please specify on which elements examples should be added ?

[Ayoazeez26]

I would love to take the signature part of the docs

[Jemiiah]

if this work isn't assigned to anybody, can i get it, @ivpavici ?

[ivpavici]

hi all!

To explain a bit more, we are not talking about rewriting Guides (like https://www.starknetjs.com/docs/guides/create_account) but adding examples to JSdocs in the code, how they can be used, for example on utils:

which looks like this:

[ivpavici]

This means you need to try out, play and test some parts of the code, to see how it works and then add an example.
Some of them can be for sure found in tests and will be easy to solve!

[ivpavici]

@Jemiiah no need to assign since multiple people can work on it... pick a part of the code (please write here which) and send a PR with this issue linked

[Ugo-X]

Hello @ivpavici would like to handle the Estimate fees segment, if there's no need for an assignment won't there be a clash at some point?

[ivpavici]

@Ugo-X I will consider PR-s from contributors who announce the parts up front.
Also, you can open an issue yourself and I can assign you! and link the issue here

[fishonamos]

Hi @ivpavici I will love to work on typeData.ts and json.ts

[BlackStarkGoku]

Hello I would like to contribute, I hope I understood well the task, I will try to write the exemples of the address.ts file.

[Iwueseiter]

@ivpavici can i work on TS Config.json and signer/interface.ts

[ivpavici]

PR by @BlackStarkGoku is a good example to take a look in what direction we want to go:
#1096

[BlackStarkGoku]

Perfect thanks @ivpavici then I will add more such as encode.ts, num.ts

[NueloSE]

@ivpavici can I work on num.ts

[ivpavici]

ok, please @BlackStarkGoku can you leave num.ts to @NueloSE

[BlackStarkGoku]

Ok I will just do encode.ts for now

[petersdt]

@ivpavici can i work on shortString.ts and transaction.ts

[NueloSE]

Hi @ivpavici num.ts has been approved.

Can i take go on with the following issues: uint256 , merkle.ts and selectors

[ivpavici]

@NueloSE thanks! go for it!

[CollinsC1O]

@ivpavici can i work on url.ts

[vibenedict]

I would like to work on hash and provider

[muheebyusufbaba1]

Can I go with stark.ts, starknetid.ts, and connect.ts

[Osatuyi]

Hi, @ivpavici can I work on index.ts and propertyOrder.ts

[ivpavici]

hey all!
It is fine to use ChatGPT to help, but it doesn't make sense to push a ChatGPT generated PR without testing and trying to understand the examples in the docs
Please test all the examples before submitting

[github-actions]

🎉 This issue has been resolved in version 6.9.0 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[KeneePatel]

Hey @ivpavici,

Just wanted to confirm if we are still open to add docs in the code. If yes, I will start on testing some functions and add documentation to it. I had a look at the code and saw some undocumented functions in shortString.ts. So, if you allow I will start to look for more, test them out, add docs and examples to them.

[ivpavici]

@KeneePatel hello! in the next-version branch we addressed the shortString functions... But feel free to take any other that are not yet addressed (or in a pending PR)

[johnkennedyb]

@ivpavici ,can I take on transaction.test.ts and contract.test.ts