Skip to content

Commit 5fb74c7

Browse files
committed
update all quickstarts with language-sdk command format and note
1 parent f92d8a8 commit 5fb74c7

File tree

7 files changed

+108
-24
lines changed

7 files changed

+108
-24
lines changed

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,20 @@ Generate a C#/.NET SDK by following the instructions on this page.
1616
Add the C#/.NET SDK generator:
1717

1818
```bash
19-
fern add fern-csharp-sdk --group sdk
19+
fern add fern-csharp-sdk --group csharp-sdk
2020
```
2121

22+
<Note>
23+
`csharp-sdk` is the name of the `generators.yml` group that configures your C#/.NET
24+
SDK's output location and other metadata. You can customize this group name to
25+
differentiate between multiple SDKs across different languages (e.g.,
26+
`internal-csharp-sdk`, `ruby-sdk`, etc) in your organization.
27+
</Note>
28+
2229
This command adds the following to `generators.yml`:
2330

2431
```yaml
25-
sdk:
32+
csharp-sdk:
2633
generators:
2734
- name: fernapi/fern-csharp-sdk
2835
version: <Markdown src="/snippets/version-number.mdx"/>
@@ -35,7 +42,7 @@ This command adds the following to `generators.yml`:
3542
3643
```bash
3744
fern/ # created by fern init
38-
sdks/ # created by fern generate --group sdk
45+
sdks/ # created by fern generate --group csharp-sdk
3946
├─ csharp
4047
└─ src/
4148
├─ YourOrganizationApi.sln

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ Add the Go SDK generator:
1919
fern add fern-go-sdk --group go-sdk
2020
```
2121
<Note>
22-
`go-sdk` is the name of `generators.yml` group that configures your Go SDK. You can customize this name however you want.
22+
`go-sdk` is the name of the `generators.yml` group that configures your Go
23+
SDK's output location and other metadata. You can customize this group name to
24+
differentiate between multiple SDKs across different languages (e.g.,
25+
`internal-go-sdk`, `ruby-sdk`, etc) in your organization.
2326
</Note>
2427

2528
This command adds the following to `generators.yml`:

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

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,19 @@ Generate a Java SDK by following the instructions on this page.
1616
Add the Java SDK generator:
1717

1818
```bash
19-
fern add fern-java-sdk --group sdk
19+
fern add fern-java-sdk --group java-sdk
2020
```
21+
<Note>
22+
`java-sdk` is the name of the `generators.yml` group that configures your Java
23+
SDK's output location and other metadata. You can customize this group name to
24+
differentiate between multiple SDKs across different languages (e.g.,
25+
`internal-java-sdk`, `ruby-sdk`, etc) in your organization.
26+
</Note>
2127

2228
This command adds the following to `generators.yml`:
2329

2430
```yaml
25-
sdk:
31+
java-sdk:
2632
generators:
2733
- name: fernapi/fern-java-sdk
2834
version: <Markdown src="/snippets/version-number.mdx"/>
@@ -31,11 +37,19 @@ This command adds the following to `generators.yml`:
3137
path: ../sdks/java
3238
```
3339
34-
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
40+
### Generate the SDK
41+
42+
Generate the SDK:
43+
44+
```bash
45+
fern generate --group java-sdk
46+
```
47+
48+
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
3549

3650
```bash
3751
fern/ # created by fern init
38-
sdks/ # created by fern generate --group sdk
52+
sdks/ # created by fern generate --group java-sdk
3953
├─ java
4054
├─ YourOrganizationApiClient.java
4155
├─ core/

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

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,20 @@ Generate a PHP SDK by following the instructions on this page.
1616
Add the PHP SDK generator:
1717

1818
```bash
19-
fern add fern-php-sdk --group sdk
19+
fern add fern-php-sdk --group php-sdk
2020
```
2121

22+
<Note>
23+
`php-sdk` is the name of the `generators.yml` group that configures your PHP
24+
SDK's output location and other metadata. You can customize this group name to
25+
differentiate between multiple SDKs across different languages (e.g.,
26+
`internal-php-sdk`, `ruby-sdk`, etc) in your organization.
27+
</Note>
28+
2229
This command adds the following to `generators.yml`:
2330

2431
```yaml
25-
sdk:
32+
php-sdk:
2633
generators:
2734
- name: fernapi/fern-php-sdk
2835
version: <Markdown src="/snippets/version-number.mdx"/>
@@ -31,11 +38,19 @@ This command adds the following to `generators.yml`:
3138
path: ../sdks/php/sdk
3239
```
3340
34-
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
41+
### Generate the SDK
42+
43+
Generate the SDK:
44+
45+
```bash
46+
fern generate --group php-sdk
47+
```
48+
49+
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
3550

3651
```bash
3752
fern/ # created by fern init
38-
sdks/ # created by fern generate --group sdk
53+
sdks/ # created by fern generate --group php-sdk
3954
├─ php
4055
└─ sdk/
4156
├─ src/

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

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,20 @@ Generate a Python SDK by following the instructions on this page.
1515
Add the Python SDK generator:
1616

1717
```bash
18-
fern add fern-python-sdk --group sdk
18+
fern add fern-python-sdk --group python-sdk
1919
```
2020

21+
<Note>
22+
`python-sdk` is the name of the `generators.yml` group that configures your Python
23+
SDK's output location and other metadata. You can customize this group name to
24+
differentiate between multiple SDKs across different languages (e.g.,
25+
`internal-python-sdk`, `ruby-sdk`, etc) in your organization.
26+
</Note>
27+
2128
This command adds the following to `generators.yml`:
2229

2330
```yaml
24-
sdk:
31+
python-sdk:
2532
generators:
2633
- name: fernapi/fern-python-sdk
2734
version: <Markdown src="/snippets/version-number.mdx"/>
@@ -30,11 +37,19 @@ This command adds the following to `generators.yml`:
3037
path: ../sdks/python
3138
```
3239
33-
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
40+
### Generate the SDK
41+
42+
Generate the SDK:
43+
44+
```bash
45+
fern generate --group python-sdk
46+
```
47+
48+
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
3449

3550
```bash
3651
fern/ # created by fern init
37-
sdks/ # created by fern generate --group sdk
52+
sdks/ # created by fern generate --group python-sdk
3853
├─ python
3954
├─ __init__.py
4055
├─ client.py

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

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,20 @@ Generate a Ruby SDK by following the instructions on this page.
1616
Add the Ruby SDK generator:
1717

1818
```bash
19-
fern add fern-ruby-sdk --group sdk
19+
fern add fern-ruby-sdk --group ruby-sdk
2020
```
2121

22+
<Note>
23+
`ruby-sdk` is the name of the `generators.yml` group that configures your Ruby
24+
SDK's output location and other metadata. You can customize this group name to
25+
differentiate between multiple SDKs across different languages (e.g.,
26+
`internal-ruby-sdk`, `python-sdk`, etc) in your organization.
27+
</Note>
28+
2229
This command adds the following to `generators.yml`:
2330

2431
```yaml
25-
sdk:
32+
ruby-sdk:
2633
generators:
2734
- name: fernapi/fern-ruby-sdk
2835
version: <Markdown src="/snippets/version-number.mdx"/>
@@ -31,11 +38,19 @@ This command adds the following to `generators.yml`:
3138
path: ../sdks/ruby
3239
```
3340
34-
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
41+
### Generate the SDK
42+
43+
Generate the SDK:
44+
45+
```bash
46+
fern generate --group ruby-sdk
47+
```
48+
49+
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
3550

3651
```bash
3752
fern/ # created by fern init
38-
sdks/ # created by fern generate --group sdk
53+
sdks/ # created by fern generate --group ruby-sdk
3954
├─ ruby
4055
├─ YourOrganization_api_client.gemspec
4156
├─ test/

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

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,40 @@ Generate a TypeScript SDK by following the instructions on this page.
1616
Add the TypeScript SDK generator:
1717

1818
```bash
19-
fern add fern-typescript-sdk --group sdk
19+
fern add fern-typescript-sdk --group ts-sdk
2020
```
2121

22+
<Note>
23+
`ts-sdk` is the name of the `generators.yml` group that configures your TypeScript
24+
SDK's output location and other metadata. You can customize this group name to
25+
differentiate between multiple SDKs across different languages (e.g.,
26+
`internal-ts-sdk`, `ruby-sdk`, etc) in your organization.
27+
</Note>
28+
2229
This command adds the following to `generators.yml`:
2330

2431
```yaml
25-
sdk:
32+
ts-sdk:
2633
generators:
2734
- name: fernapi/fern-typescript-sdk
2835
version: <Markdown src="/snippets/typescript-sdk-version.mdx"/>
2936
output:
3037
location: local-file-system
3138
path: ../sdks/typescript
3239
```
33-
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
40+
### Generate the SDK
41+
42+
Generate the SDK:
43+
44+
```bash
45+
fern generate --group ts-sdk
46+
```
47+
48+
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
3449

3550
```bash
3651
fern/ # created by fern init
37-
sdks/ # created by fern generate --group sdk
52+
sdks/ # created by fern generate --group ts-sdk
3853
├─ typescript
3954
├─ Client.ts
4055
├─ index.ts

0 commit comments

Comments
 (0)