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.

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

[Feature Request] TS SDK function documentation #4074

Open
sven-hash opened this issue Oct 30, 2023 · 4 comments
Open

[Feature Request] TS SDK function documentation #4074

sven-hash opened this issue Oct 30, 2023 · 4 comments
Labels
devrel documentation Improvements or additions to documentation enhancement New feature or request

Comments

@sven-hash
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Right now there's no functions documentation for the TS SDK (example https://docs.alephium.org/ralph/built-in-functions)

Where does the feature fit in the Nym real estate?

  • Documentation

What is this solving?
Reduce the questions about how to use the TS SDK and improve flexibility when implementing Nym in a product

Is this an update to packages or libraries?
TS SDK

@sven-hash sven-hash added enhancement New feature or request needs-triage labels Oct 30, 2023
@mfahampshire mfahampshire added documentation Improvements or additions to documentation and removed needs-triage labels Oct 30, 2023
@mfahampshire
Copy link
Contributor

fyi @Lorex-ia

@mfahampshire
Copy link
Contributor

@sven-hash it was a bit hidden but there's a doc here https://github.com/nymtech/nym/blob/develop/sdk/typescript/packages/sdk/README-GenerateDocs.md for generating them locally with typedoc.

Once this goes through user triage will get back with a response re: whether / when we look @ hosting these generated docs.

@mfahampshire
Copy link
Contributor

Ok we are looking at hosting them, its just a little on the back burner for the moment given the other focuses.

@sven-hash
Copy link
Contributor Author

It would be better if they are hosted

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devrel documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants