docs: Enhance type definitions with detailed documentation

- Added comprehensive comments to all type definitions in `src/sdl/types.ts`. - Improved clarity and understanding of v2 and v3 manifest structures. - Documented optional parameters and resource configurations for better developer guidance. - Ensured consistency in documentation style across all type definitions. Signed-off-by: Greg Osuri <[email protected]>
akash-network · Dec 15, 2024 · 473b4c7 · 473b4c7
1 parent b77c616
commit 473b4c7
Show file tree

Hide file tree

Showing 2 changed files with 253 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,10 @@ This repository is the home of `akashjs`, a library designed to facilitate inter
 | [@cosmjs/stargate](https://github.com/cosmos/cosmjs/tree/main/packages/stargate) | A client library for the Cosmos SDK 0.40+ (Stargate). |
 | [@cosmjs/proto-signing](https://github.com/cosmos/cosmjs/tree/main/packages/proto-signing) | A library for signing and broadcasting transactions using the Cosmos SDK. |
 
+### Documentation
+
+Documentation for the library is available [here](https://akash-network.github.io/akashjs).
+
 ## Compatibility
 
 Compatible with modern browsers, nodejs 14+ and Webpack 5