Skip to content

Comments

docs: add comprehensive JSDoc and README for Mesh SDK exports#801

Open
ForgeCoreye wants to merge 5 commits intoMeshJS:mainfrom
ForgeCoreye:docs/mesh-api-documentation
Open

docs: add comprehensive JSDoc and README for Mesh SDK exports#801
ForgeCoreye wants to merge 5 commits intoMeshJS:mainfrom
ForgeCoreye:docs/mesh-api-documentation

Conversation

@ForgeCoreye
Copy link

This PR adds missing JSDoc comments and API documentation for the Mesh SDK's TypeScript libraries. I've documented function signatures, parameter types, return values, and usage examples for the undocumented exports. This makes the SDK more accessible to Cardano developers without changing any runtime behavior.

Changes

  • packages/mesh-core-cst/README.md
  • packages/mesh-provider/README.md
  • packages/mesh-wallet/README.md
  • packages/mesh-transaction/README.md
  • packages/mesh-common/README.md

Testing

  • npm ci
  • npm run lint
  • npm test
  • npm run build

@ForgeCoreye
Copy link
Author

Hi team — I noticed a mistake in this PR after opening it.

packages/mesh-provider/README.md should not be here — mesh-provider is not a package in this repo. I apologize for the noise on that file; it came from an incorrect import assumption (@meshsdk/provider) that leaked into the content.

The other four files (mesh-wallet, mesh-transaction, mesh-core-cst, mesh-common) are intentional and document the existing but largely undocumented public APIs for each package.

Happy to drop the mesh-provider file in a follow-up commit if the rest looks useful to you, or close and re-open a clean PR — whichever you prefer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant