fern icon indicating copy to clipboard operation
fern copied to clipboard

[Fern's Documentation] SDK generator options missing from documentation

Open mstade opened this issue 1 year ago • 3 comments

What can be improved

Previously it was possible to see the available options for any given SDK generator on Fern's website. This is no longer possible it seems. The list of SDKs don't link to any SDK specific documentation: https://buildwithfern.com/learn/sdks/introduction/overview

I also weren't able to find this information anywhere else on the site.

mstade avatar Apr 22 '24 13:04 mstade

We're iterating on our documentation and expect it to get to parity with our previous docs over time. For now, you can use this link to access our previous docs site which has the info I think you're looking for! https://docs.buildwithfern.com/generate-sd-ks/generators/type-script-node-js-sdk

dannysheridan avatar Apr 22 '24 13:04 dannysheridan

That link is unfortunately wildly out of date, listing the latest version of the TS generator as 0.9.5. Could this ticket be reopened until such time the docs are updated?

I've previously opened an issue on the discrepancies of the docs site you linked to as well: https://github.com/fern-api/fern/issues/3256

mstade avatar Apr 22 '24 13:04 mstade

Any updates on this?

mstade avatar Jun 02 '24 19:06 mstade

Will this documentation make a return at some point?

mstade avatar Oct 28 '24 23:10 mstade

@mstade this isn't something we've got on the near term roadmap. We're prioritizing our time based on what our customers are asking for.

Here's a link to the TypeScript SDK generator custom config (without full documentation): https://github.com/fern-api/fern/blob/main/generators/typescript/sdk/cli/src/custom-config/SdkCustomConfig.ts

dannysheridan avatar Oct 29 '24 00:10 dannysheridan