unleash icon indicating copy to clipboard operation
unleash copied to clipboard

The documentation for the node client-sdk doesn't mention events

Open SimonSimCity opened this issue 3 years ago • 2 comments
trafficstars

The documentation of the client-sdk for node (https://docs.getunleash.io/sdks/node_sdk) does not mention any of the available events (https://github.com/Unleash/unleash-client-node#events). Maybe its best to just link to the readme of the repository instead of having two docs you need to keep in sync.

SimonSimCity avatar Feb 23 '22 09:02 SimonSimCity

Thanks for pointing this out. None of the SDK tutorials in the docs currently explains all the capabilities of the SDKs. We plan to move more of the individual SDK docs in the the combined documentation. Stay tuned!

ivarconr avatar Feb 23 '22 21:02 ivarconr

@SimonSimCity Yes, you're right! Thanks for raising this 😄 What Ivar says is correct: we've got plans to start integrating the documentation from the SDK repos into docs.getunleash.io, so we'll only need to keep one set of docs up to date. It's been researched and we've found a way forward, so it's on the way ✌🏼

thomasheartman avatar Feb 24 '22 09:02 thomasheartman

any updates on this @thomasheartman ?

ivarconr avatar Nov 09 '22 22:11 ivarconr

Not yet, I'm afraid. With the OpenAPI work and other things going on, we haven't gotten around to actually implementing this, though.

thomasheartman avatar Nov 10 '22 14:11 thomasheartman