diff --git a/fern/products/sdks/overview/python/quickstart.mdx b/fern/products/sdks/overview/python/quickstart.mdx index c26144140..71941fbf0 100644 --- a/fern/products/sdks/overview/python/quickstart.mdx +++ b/fern/products/sdks/overview/python/quickstart.mdx @@ -20,7 +20,36 @@ Generate a Python SDK by following the instructions on this page. - + + + + + 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: + config: + outputSourceFiles: true + ``` + + `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. + diff --git a/fern/products/sdks/overview/typescript/quickstart.mdx b/fern/products/sdks/overview/typescript/quickstart.mdx index 3c64cad90..514f7caeb 100644 --- a/fern/products/sdks/overview/typescript/quickstart.mdx +++ b/fern/products/sdks/overview/typescript/quickstart.mdx @@ -18,9 +18,38 @@ Generate a TypeScript SDK by following the instructions on this page. + + + 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: + config: + outputSourceFiles: true + ``` + + `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. + + diff --git a/fern/products/sdks/snippets/option-3-fern-def.mdx b/fern/products/sdks/snippets/option-3-fern-def.mdx index 65ff4ffd0..43fbb5e7f 100644 --- a/fern/products/sdks/snippets/option-3-fern-def.mdx +++ b/fern/products/sdks/snippets/option-3-fern-def.mdx @@ -1,4 +1,3 @@ - 1. Initialize the Fern folder using the Fern Definition by running the following command: ```bash @@ -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: - config: - outputSourceFiles: true - ``` - - `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. - \ No newline at end of file