Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[sdk/javascript] Generate and publish documentation from source code #300

Closed
cryptoBeliever opened this issue Jul 6, 2022 · 0 comments · Fixed by #1070
Closed

[sdk/javascript] Generate and publish documentation from source code #300

cryptoBeliever opened this issue Jul 6, 2022 · 0 comments · Fixed by #1070
Assignees
@Jaguar0625 @gimre-xymcity
Labels
sdk-javascript Related to the Javascript SDK. Status: WIP This issue or PR is a work in progress.

Comments

@cryptoBeliever
Copy link
Contributor

Current Behaviour

Currently, we are not generating or publishing documentation generated from the source code.

Expected Behavior

Generate documentation from source code and publish it online.
For javascript, we could possibly use https://jsdoc.app/

Example docs available for old SDK:
https://symbol.github.io/symbol-sdk-typescript-javascript/1.0.3/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Jaguar0625 Jaguar0625

@gimre-xymcity gimre-xymcity

Labels
sdk-javascript Related to the Javascript SDK. Status: WIP This issue or PR is a work in progress.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[sdk]: add generation for class level documentation symbol/symbol
3 participants
@Jaguar0625 @gimre-xymcity @cryptoBeliever