fix(docs): Improve Generated documentation #65
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
milosh86
approved these changes
Jun 20, 2023
antonbaliasnikov
suggested changes
Jun 20, 2023
antonbaliasnikov
suggested changes
Jun 21, 2023
antonbaliasnikov
approved these changes
Jun 21, 2023
atala-dev
added a commit
that referenced
this pull request
Jun 22, 2023
## [2.0.2](v2.0.1...v2.0.2) (2023-06-22) ### Bug Fixes * **docs:** Correct the required commands to run the nodejs + browser … ([#64](#64)) ([fec65fe](fec65fe)) * **docs:** Improve Generated documentation ([#65](#65)) ([db3c20e](db3c20e)) * Documentation improvements ([#62](#62)) ([6d43d03](6d43d03))
github-actions bot
pushed a commit
that referenced
this pull request
Jun 22, 2023
## [2.0.2](v2.0.1...v2.0.2) (2023-06-22) ### Bug Fixes * **docs:** Correct the required commands to run the nodejs + browser … ([#64](#64)) ([fec65fe](fec65fe)) * **docs:** Improve Generated documentation ([#65](#65)) ([db3c20e](db3c20e)) * Documentation improvements ([#62](#62)) ([6d43d03](6d43d03))
mixmix
pushed a commit
to mixmix/atala-prism-wallet-sdk-ts
that referenced
this pull request
May 6, 2024
Signed-off-by: Francisco Javier Ribó Labrador <[email protected]>
mixmix
pushed a commit
to mixmix/atala-prism-wallet-sdk-ts
that referenced
this pull request
May 6, 2024
## [2.0.2](hyperledger-identus/sdk-ts@v2.0.1...v2.0.2) (2023-06-22) ### Bug Fixes * **docs:** Correct the required commands to run the nodejs + browser … ([hyperledger-identus#64](hyperledger-identus#64)) ([fec65fe](hyperledger-identus@fec65fe)) * **docs:** Improve Generated documentation ([hyperledger-identus#65](hyperledger-identus#65)) ([db3c20e](hyperledger-identus@db3c20e)) * Documentation improvements ([hyperledger-identus#62](hyperledger-identus#62)) ([6d43d03](hyperledger-identus@6d43d03)) Signed-off-by: Francisco Javier Ribó Labrador <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding typedoc to generate documentation for interfaces and most components for us automatically, we just are required to document with standard jsdoc comments the implementations. Types are documented by default.
Also took the freedom to hide some classes in favour of the future cryptograhic abstraction, so I'm not exposing secp, ed, etc.
Checklist