Skip to content

Commit 3ed172d

Browse files
authored
Make wording less repetitive in quickstarts (#191)
1 parent 845dc9d commit 3ed172d

File tree

7 files changed

+41
-34
lines changed

7 files changed

+41
-34
lines changed

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Generate a C#/.NET SDK by following the instructions on this page.
1313

1414
### Add the SDK generator
1515

16-
Add the C#/.NET SDK generator:
16+
Run the following command to add the C#/.NET SDK generator to `generators.yml`:
1717

1818
```bash
1919
fern add fern-csharp-sdk --group csharp-sdk
@@ -26,17 +26,24 @@ fern add fern-csharp-sdk --group csharp-sdk
2626
`ruby-sdk`, etc) in your organization.
2727
</Note>
2828

29-
This command adds the following to `generators.yml`:
29+
This command adds the following `group` to `generators.yml`:
3030

31-
```yaml
32-
csharp-sdk:
31+
```yaml title="generators.yml"
32+
csharp-sdk: # group name
3333
generators:
3434
- name: fernapi/fern-csharp-sdk
3535
version: <Markdown src="/snippets/version-number-csharp.mdx"/>
3636
output:
3737
location: local-file-system
3838
path: ../sdks/csharp
3939
```
40+
### Generate the SDK
41+
42+
Run the following command to generate your SDK:
43+
44+
```bash
45+
fern generate --group csharp-sdk
46+
```
4047

4148
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
4249

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Generate a Go SDK by following the instructions on this page.
1313

1414
### Add the SDK generator
1515

16-
Add the Go SDK generator:
16+
Run the following command to add the Go SDK generator to `generators.yml`:
1717

1818
```bash
1919
fern add fern-go-sdk --group go-sdk
@@ -25,10 +25,10 @@ fern add fern-go-sdk --group go-sdk
2525
`ruby-sdk`, etc) in your organization.
2626
</Note>
2727

28-
This command adds the following to `generators.yml`:
28+
This command adds the following `group` to `generators.yml`:
2929

30-
```yaml
31-
go-sdk:
30+
```yaml title="generators.yml"
31+
go-sdk: # group name
3232
generators:
3333
- name: fernapi/fern-go-sdk
3434
version: <Markdown src="/snippets/version-number-go.mdx"/>
@@ -39,7 +39,7 @@ This command adds the following to `generators.yml`:
3939
4040
### Generate the SDK
4141
42-
Generate the SDK:
42+
Run the following command to generate your SDK:
4343
4444
```bash
4545
fern generate --group go-sdk

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Generate a Java SDK by following the instructions on this page.
1313

1414
### Add the SDK generator
1515

16-
Add the Java SDK generator:
16+
Run the following command to add the Java SDK generator to `generators.yml`:
1717

1818
```bash
1919
fern add fern-java-sdk --group java-sdk
@@ -25,10 +25,10 @@ fern add fern-java-sdk --group java-sdk
2525
`ruby-sdk`, etc) in your organization.
2626
</Note>
2727

28-
This command adds the following to `generators.yml`:
28+
This command adds the following `group` to `generators.yml`:
2929

30-
```yaml
31-
java-sdk:
30+
```yaml title="generators.yml"
31+
java-sdk: # group name
3232
generators:
3333
- name: fernapi/fern-java-sdk
3434
version: <Markdown src="/snippets/version-number-java.mdx"/>
@@ -39,7 +39,7 @@ This command adds the following to `generators.yml`:
3939
4040
### Generate the SDK
4141
42-
Generate the SDK:
42+
Run the following command to generate your SDK:
4343
4444
```bash
4545
fern generate --group java-sdk

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Generate a PHP SDK by following the instructions on this page.
1313

1414
### Add the SDK generator
1515

16-
Add the PHP SDK generator:
16+
Run the following command to add the PHP SDK generator to `generators.yml`:
1717

1818
```bash
1919
fern add fern-php-sdk --group php-sdk
@@ -26,10 +26,10 @@ fern add fern-php-sdk --group php-sdk
2626
`ruby-sdk`, etc) in your organization.
2727
</Note>
2828

29-
This command adds the following to `generators.yml`:
29+
This command adds the following `group` to `generators.yml`:
3030

31-
```yaml
32-
php-sdk:
31+
```yaml title="generators.yml"
32+
php-sdk: # group name
3333
generators:
3434
- name: fernapi/fern-php-sdk
3535
version: <Markdown src="/snippets/version-number-php.mdx"/>
@@ -40,7 +40,7 @@ This command adds the following to `generators.yml`:
4040
4141
### Generate the SDK
4242
43-
Generate the SDK:
43+
Run the following command to generate your SDK:
4444
4545
```bash
4646
fern generate --group php-sdk

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Generate a Python SDK by following the instructions on this page.
1212

1313
### Add the SDK generator
1414

15-
Add the Python SDK generator:
15+
Run the following command to add the Python SDK generator to `generators.yml`:
1616

1717
```bash
1818
fern add fern-python-sdk --group python-sdk
@@ -25,10 +25,10 @@ fern add fern-python-sdk --group python-sdk
2525
`ruby-sdk`, etc) in your organization.
2626
</Note>
2727

28-
This command adds the following to `generators.yml`:
28+
This command adds the following `group` to `generators.yml`:
2929

30-
```yaml
31-
python-sdk:
30+
```yaml title="generators.yml"
31+
python-sdk: # group name
3232
generators:
3333
- name: fernapi/fern-python-sdk
3434
version: <Markdown src="/snippets/version-number-python.mdx"/>
@@ -39,7 +39,7 @@ This command adds the following to `generators.yml`:
3939
4040
### Generate the SDK
4141
42-
Generate the SDK:
42+
Run the following command to generate your SDK:
4343
4444
```bash
4545
fern generate --group python-sdk

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Generate a Ruby SDK by following the instructions on this page.
1313

1414
### Add the SDK generator
1515

16-
Add the Ruby SDK generator:
16+
Run the following command to add the Ruby SDK generator to `generators.yml`:
1717

1818
```bash
1919
fern add fern-ruby-sdk --group ruby-sdk
@@ -26,10 +26,10 @@ fern add fern-ruby-sdk --group ruby-sdk
2626
`python-sdk`, etc) in your organization.
2727
</Note>
2828

29-
This command adds the following to `generators.yml`:
29+
This command adds the following `group` to `generators.yml`:
3030

31-
```yaml
32-
ruby-sdk:
31+
```yaml title="generators.yml"
32+
ruby-sdk: # group name
3333
generators:
3434
- name: fernapi/fern-ruby-sdk
3535
version: <Markdown src="/snippets/version-number-ruby.mdx"/>
@@ -40,7 +40,7 @@ This command adds the following to `generators.yml`:
4040
4141
### Generate the SDK
4242
43-
Generate the SDK:
43+
Run the following command to generate your SDK:
4444
4545
```bash
4646
fern generate --group ruby-sdk

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Generate a TypeScript SDK by following the instructions on this page.
1313

1414
### Add the SDK generator
1515

16-
Add the TypeScript SDK generator:
16+
Run the following command to add the TypeScript SDK generator to `generators.yml`:
1717

1818
```bash
1919
fern add fern-typescript-sdk --group ts-sdk
@@ -26,10 +26,10 @@ fern add fern-typescript-sdk --group ts-sdk
2626
`ruby-sdk`, etc) in your organization.
2727
</Note>
2828

29-
This command adds the following to `generators.yml`:
29+
This command adds the following `group` to `generators.yml`:
3030

31-
```yaml
32-
ts-sdk:
31+
```yaml title="generators.yml"
32+
ts-sdk: # group name
3333
generators:
3434
- name: fernapi/fern-typescript-sdk
3535
version: <Markdown src="/snippets/version-number-ts.mdx"/>
@@ -39,7 +39,7 @@ This command adds the following to `generators.yml`:
3939
```
4040
### Generate the SDK
4141
42-
Generate the SDK:
42+
Run the following command to generate your SDK:
4343
4444
```bash
4545
fern generate --group ts-sdk

0 commit comments

Comments
 (0)