Hey all! I'm looking to improve our docs :page_fac...
# announcements
s
Hey all! I'm looking to improve our docs 📄, especially around our SDKs. If there's anything you wish could've been clearer or should be added, let's chat about it. Feel free to book a meeting, post it here, or send me a DM: https://calendar.app.google/V29yNm9ek6F6vRec7
👍 5
r
confusion over client name I found it a bit confusing trying to figure out the relationship between the JS (frontend) and the NodeJS (backend) SDKs. Example: Node.JS SDK uses
GrowthBookClient
, but the frontend JS SDK uses
GrowthBook
. But when I think "client SDK", I think frontend (vs server-side SDK). Perhaps just a note in the NodeJS docs explaining the lineage of the name, or reinforcing "hey it's called GrowthBookClient but you're in the right place for the server-side SDK" would be enough.
confusion over client init behavior I've not clear on what happens when you call
client.init()
with no timeout arg. Is there a default timeout? Or is this by default going to block the application from ever starting if growthbook down / network issue? In either case, this should be called out clearly in the docs wherever
init
is used.
s
Great feedback, @rough-park-54233. Thank you. We have a bit about
init
here: https://docs.growthbook.io/lib/js#built-in-fetching-and-caching If you don't pass in a timeout and the network call fails, GB won't error out. Instead, all features will evaluate to
null
.
r
Yes, that is helpful - although what I'm looking for is if there is a timeout by default. So, if you don't pass a timeout can it hang indefinitely? This is a common error people make so figured it'd be great to see that in the docs.
👍 1
b
Oh dude, missed this thread earlier. One thing I noticed missing that was a beast to figure out was related to the REST API. Would be good to have examples of the different parameter inputs and responses instead of just the empty shells. One example: getting experiment results, I had a lot of trial and error figuring out that to get dimensions in the results I had to use
exp:[dim name]
Or that phases index started at 0.
s
Good shout. Thanks for this! I'll put it on my list.