diff --git a/fern/products/sdks/overview/typescript/quickstart.mdx b/fern/products/sdks/overview/typescript/quickstart.mdx index e05e086f0..138f4778d 100644 --- a/fern/products/sdks/overview/typescript/quickstart.mdx +++ b/fern/products/sdks/overview/typescript/quickstart.mdx @@ -3,13 +3,29 @@ title: TypeScript Quickstart description: Get started quickly with the Fern TypeScript SDK. --- -Generate a TypeScript SDK by following the instructions on this page. +Generate a TypeScript SDK by following the instructions on this page. - +This is a quickstart. + + + This page assumes that you have: + + * An initialized `fern` folder on your local machine. See [Set up the `fern` + folder](/sdks/overview/quickstart). + * A GitHub repository for your SDK. See [Project Structure](/sdks/overview/github). + - + ### Pass `fern check` + + Run `fern check` to ensure that your API definition is valid. If there are any errors, + fix them before proceeding. + + + If you're using an OpenAPI Specification, check out all of our + [supported extensions](/learn/api-definition/openapi/extensions). + ## Add the SDK generator @@ -32,7 +48,7 @@ This command adds the following `group` to `generators.yml`: ts-sdk: # group name generators: - name: fernapi/fern-typescript-sdk - version: + version: 2.6.8 output: location: local-file-system path: ../sdks/typescript @@ -45,7 +61,7 @@ This command adds the following `group` to `generators.yml`: fern generate --group ts-sdk ``` - + This creates a `sdks` folder in your current directory. The resulting folder structure looks like this: ```bash fern/ # created by fern init