Skip to content

Commit 638df60

Browse files
committed
Visual Editor: Update
1 parent 62b5dfb commit 638df60

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

fern/products/sdks/overview/typescript/quickstart.mdx

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,29 @@ title: TypeScript Quickstart
33
description: Get started quickly with the Fern TypeScript SDK.
44
---
55

6-
Generate a TypeScript SDK by following the instructions on this page.
6+
Generate a TypeScript SDK by following the instructions on this page.
77

8-
<Markdown src="/products/sdks/snippets/setup-fern-folder-callout.mdx"/>
8+
This is a quickstart.
9+
10+
<Info>
11+
This page assumes that you have:
12+
13+
* An initialized `fern` folder on your local machine. See [Set up the `fern`
14+
folder](/sdks/overview/quickstart).
15+
* A GitHub repository for your SDK. See [Project Structure](/sdks/overview/github).
16+
</Info>
917

1018
<Steps>
1119

12-
<Markdown src="/products/sdks/snippets/pass-fern-check.mdx"/>
20+
### Pass `fern check`
21+
22+
Run `fern check` to ensure that your API definition is valid. If there are any errors,
23+
fix them before proceeding.
24+
25+
<Note>
26+
If you're using an OpenAPI Specification, check out all of our
27+
[supported extensions](/learn/api-definition/openapi/extensions).
28+
</Note>
1329

1430
## Add the SDK generator
1531

@@ -32,7 +48,7 @@ This command adds the following `group` to `generators.yml`:
3248
ts-sdk: # group name
3349
generators:
3450
- name: fernapi/fern-typescript-sdk
35-
version: <Markdown src="/snippets/version-number-ts.mdx"/>
51+
version: 2.6.8
3652
output:
3753
location: local-file-system
3854
path: ../sdks/typescript
@@ -45,7 +61,7 @@ This command adds the following `group` to `generators.yml`:
4561
fern generate --group ts-sdk
4662
```
4763

48-
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
64+
This creates a `sdks` folder in your current directory. The resulting folder structure looks like this:
4965

5066
```bash
5167
fern/ # created by fern init

0 commit comments

Comments
 (0)