Skip to content

Commit 00459fd

Browse files
committed
fix some errors
1 parent 0198cdc commit 00459fd

File tree

4 files changed

+30
-49
lines changed

4 files changed

+30
-49
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,16 @@ Generate a Python SDK by following the instructions on this page.
4747
```
4848
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
4949
50-
```bash
51-
fern/ # created in step 1
52-
sdks/ # created by fern generate --group sdk
53-
├─ python
54-
├─ __init__.py
55-
├─ client.py
56-
├─ core/
57-
└─ imdb/ # or the name of your API
58-
─ errors/
59-
└─ types/
60-
```
50+
```bash
51+
fern/ # created in step 1
52+
sdks/ # created by fern generate --group sdk
53+
├─ python
54+
├─ __init__.py
55+
├─ client.py
56+
├─ core/
57+
└─ imdb/ # or the name of your API
58+
─ errors/
59+
└─ types/
60+
```
6161

6262
</Steps>

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

Lines changed: 13 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,12 @@ Generate a TypeScript SDK by following the instructions on this page.
1515
You can use either the OpenAPI definition, AsyncAPI definition, or Fern Definition to generate your SDK.
1616

1717
<AccordionGroup>
18-
<Accordion title="Option 1: OpenAPI">
1918
<Markdown src="/products/sdks/snippets/option-1-openapi.mdx"/>
20-
</Accordion>
2119

22-
<Accordion title="Option 2: AsyncAPI">
2320
<Markdown src="/products/sdks/snippets/option-2-asyncapi.mdx"/>
24-
</Accordion>
2521

26-
<Accordion title="Option 3: Fern Definition">
2722
<Markdown src="/products/sdks/snippets/option-3-fern-def.mdx"/>
2823

29-
1. Add the config option `outputSourceFiles: true` to `generators.yml`. This ensures your SDK contains `.ts` files instead of compiled output.
30-
31-
```yaml {11-12}
32-
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
33-
default-group: local
34-
groups:
35-
local:
36-
generators:
37-
- name: fernapi/fern-typescript-node-sdk
38-
output:
39-
location: local-file-system
40-
path: ../sdks/typescript
41-
version: <Markdown src="/snippets/version-number.mdx"/>
42-
config:
43-
outputSourceFiles: true
44-
```
45-
</Accordion>
4624
</AccordionGroup>
4725

4826
<Markdown src="/products/sdks/snippets/pass-fern-check.mdx"/>
@@ -68,18 +46,18 @@ Generate a TypeScript SDK by following the instructions on this page.
6846
```
6947
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
7048
71-
```bash
72-
fern/ # created in step 1
73-
sdks/ # created by fern generate --group sdk
74-
├─ typescript
75-
├─ cjs/
76-
├─ api/
77-
├─ core/
78-
└─ errors/
79-
└─ esm/
80-
├─ api/
81-
├─ core/
82-
└─ errors/
83-
```
49+
```bash
50+
fern/ # created in step 1
51+
sdks/ # created by fern generate --group sdk
52+
├─ typescript
53+
├─ cjs/
54+
├─ api/
55+
├─ core/
56+
└─ errors/
57+
└─ esm/
58+
├─ api/
59+
├─ core/
60+
└─ errors/
61+
```
8462

8563
</Steps>
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
### Generate the SDK
1+
### Generate the SDK
22

33
Generate the SDK:
44

55
```bash
6-
fern generate --group sdk```
6+
fern generate --group sdk
7+
```
8+
79
This creates a `sdks` folder in your current directory. The resulting folder structure looks like this:

fern/products/sdks/snippets/option-3-fern-def.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
1. Add the config option `outputSourceFiles: true` to
3232
`generators.yml`. This ensures your SDK contains source files in
33-
your designated language instead of compiled output.
33+
your preferred SDK language instead of compiled output.
3434

3535
```yaml {11-12}
3636
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
@@ -53,3 +53,4 @@
5353
group, or if you explicitly target it with `fern generate --group
5454
local`. In subsequent steps, you'll add an additional generator for your
5555
preferred SDK language.</Note>
56+
</Accordion>

0 commit comments

Comments
 (0)