[Feature Request] TS SDK function documentation

[sven-hash]

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

[mfahampshire]

fyi @Lorex-ia

[mfahampshire]

@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]

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

[sven-hash]

It would be better if they are hosted

[gyrusdentatus]

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

@sven-hash ! <3 ! yes - that is why good docs are really important and awesome.
Especially with such a massive monorepo now… one might feel unsure where to even begin (Unless It's GUI NymVPN or wallet of course)