Javascript API documentation

[CryptoPascal31]

Please confirm the following:

• I have read the Code of Conduct
• The bug was not reported before
• I am using the latest version of the relevant package(s)

What operating system are you using? And what version?

Linux

What environment or browser are you using? And what version?

Node.js

What package is the bug report about?

Other... (please describe in bug report)

Describe the bug

Kadena-js is a great piece of code:

• Clean and convenient API.
• Very reliable and very few bugs

But it is SERIOUSLY lacking in documentation. There are only a couple of very incomplete and outdated README files.

IMHO, a library without proper documentation is worthless.

Developers (without necessarily deep knowledge in JS, like me) should not be force to dig into the source code and PR comments to understand how the classes and functions are supposed to be used.

I recommend handling this documentation issue with a high priority.

Steps to reproduce the behavior

Simply try to build something on top Kadena.js

What did you expect to happen?

A complete documentation of the API.

Participation

• I am willing to submit a pull request for this issue.

[Randynamic]

We are working hard on this but TY for the notion. When updated we will close the issue 👍

[raduciobanu22]

I'm on the same page with @CryptoPascal31 here, been using KadenaJS in the last few months and I'm always digging through the source code, every now and then stumble upon something I didn't know it existed and I already wrote it myself.
I particularly like the format these guys have: https://viem.sh/docs/actions/public/getBalance, it's really well structured.

Looking forward to see what you guys come up with! Thanks @Randynamic and everyone else working on this!

[daplcor]

Promoting and updating the client-utils should help with this, for example there is a getBalance feature and other pre-defined things. Why not consider offering a small bounty to encourage people to add more contracts and quick calls so your team only has to determine a wish list and process?

I don't use the client-utilties for the same reason Radu mentioned, most of us already have the code we just drag and drop. But I've been trying to consolidate into kadenajs and 95% of my reading is directly in the source code. I'm happy to point new developers to these tools, as in the long run it should save them time and effort.

[github-actions]

This issue is stale because it is open for 60 days with no activity

[lsgunnlsgunn]

The first pass of @kadena/client documentation is live.
client-utils and an overview of all of the packages is still TBD.

[github-actions]

This issue is stale because it is open for 60 days with no activity