Docs: add a code example for each of our SDK classes (preferably in Go)

kurtosis-tech / kurtosis

A platform for packaging and launching ephemeral backend stacks with a focus on approachability for the average developer.

https://docs.kurtosistech.com/

Apache License 2.0

353 stars 52 forks source link

Docs: add a code example for each of our SDK classes (preferably in Go) #1283

Closed leeederek closed 12 months ago

leeederek commented 1 year ago

Where did you see the issue in our documentation?

https://docs.kurtosis.com/SDK

Issue description

We've gotten feedback that using the SDK is not as friendly as we'd like it to be (see: https://github.com/kurtosis-tech/kurtosis/issues/1152). To make the usage easier for new users to understand, I'd like to propose we add at least 1 code example to each of the SDK classes that we have.

leeederek commented 1 year ago

Adding more scope to this original ask: the code examples should be added for every language we support (Go, Typescript, Rust?) & I'd like to see us implement a similar UX to what Stripe has: https://stripe.com/docs/api/balance/balance_retrieve?lang=node where you can change the language:

Related issue opened by @galenmarchetti here: https://github.com/kurtosis-tech/kurtosis/issues/1338

leeederek commented 1 year ago

Re-opening as this was not related to #1436