Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion fern/products/sdks/overview/python/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,36 @@ Generate a Python SDK by following the instructions on this page.

<Markdown src="/products/sdks/snippets/option-2-asyncapi.mdx"/>

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

<Markdown src="/products/sdks/snippets/option-3-fern-def.mdx"/>

2. Add the config option `outputSourceFiles: true` to
`generators.yml`. This ensures your SDK contains source files in
your preferred SDK language instead of compiled output.

```yaml {11-12}
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
default-group: local
groups:
local:
generators:
- name: fernapi/fern-typescript-node-sdk
output:
location: local-file-system
path: ../sdks/typescript
version: <Markdown src="/snippets/version-number.mdx"/>
config:
outputSourceFiles: true
```

<Note>`fern init` creates a default configuration that includes the
TypeScript Node SDK generator. The `local` group containing this
generator only generates if you run fern generate without specifying a
group, or if you explicitly target it with `fern generate --group
local`. In subsequent steps, you'll add an additional generator for your
preferred SDK language.</Note>
</Accordion>

</AccordionGroup>

Expand Down
29 changes: 29 additions & 0 deletions fern/products/sdks/overview/typescript/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,38 @@ Generate a TypeScript SDK by following the instructions on this page.
<Markdown src="/products/sdks/snippets/option-1-openapi.mdx"/>

<Markdown src="/products/sdks/snippets/option-2-asyncapi.mdx"/>

<Accordion title="Option 3: Fern Definition">

<Markdown src="/products/sdks/snippets/option-3-fern-def.mdx"/>

2. Add the config option `outputSourceFiles: true` to
`generators.yml`. This ensures your SDK contains source files in
your preferred SDK language instead of compiled output.

```yaml {11-12}
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
default-group: local
groups:
local:
generators:
- name: fernapi/fern-typescript-node-sdk
output:
location: local-file-system
path: ../sdks/typescript
version: <Markdown src="/snippets/version-number.mdx"/>
config:
outputSourceFiles: true
```

<Note>`fern init` creates a default configuration that includes the
TypeScript Node SDK generator. The `local` group containing this
generator only generates if you run fern generate without specifying a
group, or if you explicitly target it with `fern generate --group
local`. In subsequent steps, you'll add an additional generator for your
preferred SDK language.</Note>
</Accordion>

</AccordionGroup>

<Markdown src="/products/sdks/snippets/pass-fern-check.mdx"/>
Expand Down
27 changes: 0 additions & 27 deletions fern/products/sdks/snippets/option-3-fern-def.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
<Accordion title="Option 3: Fern Definition">
1. Initialize the Fern folder using the Fern Definition by running the following command:

```bash
Expand Down Expand Up @@ -28,29 +27,3 @@

{/* TODO: show what generators.yml looks like, link out to configuration.md */}

2. Add the config option `outputSourceFiles: true` to
`generators.yml`. This ensures your SDK contains source files in
your preferred SDK language instead of compiled output.

```yaml {11-12}
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
default-group: local
groups:
local:
generators:
- name: fernapi/fern-typescript-node-sdk
output:
location: local-file-system
path: ../sdks/typescript
version: <Markdown src="/snippets/version-number.mdx"/>
config:
outputSourceFiles: true
```

<Note>`fern init` creates a default configuration that includes the
TypeScript Node SDK generator. The `local` group containing this
generator only generates if you run fern generate without specifying a
group, or if you explicitly target it with `fern generate --group
local`. In subsequent steps, you'll add an additional generator for your
preferred SDK language.</Note>
</Accordion>