Enhance Documentation Using JSDoc/TsDoc Standards

[h0ngcha0]

The SDK codebase would benefit from consistent, high-quality documentation to improve maintainability, ease of use, and on-boarding for new developers. To achieve this, we propose adopting JSDoc and/or TSDoc standards throughout the project. This will provide a standardized way to document functions, classes, parameters, return types, and modules, making it easier to generate comprehensive, up-to-date documentation.

Please start with the web3 package.

[alanJames00]

I would like to work on this.
Is there any specific requirements on tooling ?
I'm currently assuming the following:

1. Go with TSDoc since the codebase is already using TypeScript
2. typedoc and ts-doc as devDependencies.
3. Default linter config

[polarker]

Hey @alanJames00, those requirements are excellent!

I’d like to suggest an additional requirement to enhance developer usability:

• Developers should be able to easily navigate the web3 package using the generated documentation.

Here are a couple of points to consider:

1. Set up tools to generate HTML or Markdown documentation from JSDoc/TSDoc annotations for easy external reference.
2. Ensure that when the SDK is installed as a dependency, developers can navigate the documentation directly within their IDE by jumping to definitions.

[alanJames00]

Got it. I will start working on the web3 package mentioned in the Issue.