From 37888b0c44ffb075352ce2fd55dc31be5e04eb8f Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Thu, 20 Aug 2026 16:03:31 +0000 Subject: [PATCH 1/2] Add prerequisites and generator config context to Ruby SDK quickstart --- fern/products/sdks/generators/ruby/quickstart.mdx | 12 ++++++++++++ fern/products/sdks/snippets/init-fern-folder.mdx | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/fern/products/sdks/generators/ruby/quickstart.mdx b/fern/products/sdks/generators/ruby/quickstart.mdx index e4cdf781d..b60c1e849 100644 --- a/fern/products/sdks/generators/ruby/quickstart.mdx +++ b/fern/products/sdks/generators/ruby/quickstart.mdx @@ -18,6 +18,12 @@ If the user already has a `fern/` folder set up, they can skip the first two ste Generate a Ruby SDK with Fern. Follow the [Ruby SDK quickstart](https://buildwithfern.com/learn/sdks/generators/ruby/quickstart.md) step by step. +## Prerequisites + +- [Node.js](https://nodejs.org) 18 or later, required to install the Fern CLI from npm +- An OpenAPI specification in JSON or YAML, or the Petstore example spec to follow along +- A Fern account, required by `fern generate`. [Sign up](https://buildwithfern.com) if you don't have one. + @@ -48,6 +54,12 @@ This command adds the following `group` to `generators.yml`: location: local-file-system path: ../sdks/ruby ``` + +In this group: + +- `ruby-sdk` is the group name, a label you choose to identify this set of generators. Pass it to `fern generate --group ruby-sdk` to run only the generators in this group. To rename the group, for example to `ruby`, change the key in `generators.yml` and pass the new name to `--group`. +- `fern-ruby-sdk` is the generator name, Fern's official Ruby SDK generator. +- `output.location: local-file-system` writes the SDK to your machine at `output.path`. When you're ready to publish, change the location to `github` and point it at your SDK repository. diff --git a/fern/products/sdks/snippets/init-fern-folder.mdx b/fern/products/sdks/snippets/init-fern-folder.mdx index 1a3799465..78a10c6e7 100644 --- a/fern/products/sdks/snippets/init-fern-folder.mdx +++ b/fern/products/sdks/snippets/init-fern-folder.mdx @@ -45,7 +45,7 @@ ``` - Initialize the fern folder with your existing OpenAPI specification. Specify your organization name using the `--organization` flag. + Initialize the fern folder with your existing OpenAPI specification. Specify your organization name using the `--organization` flag. Replace `` with the organization name on your Fern account, visible in the [Fern Dashboard](https://buildwithfern.com/dashboard). Organization names cannot contain spaces. Before running `fern init`, ask the user two things: From 79a67794795a80c0d15ee19eb7914ab349ead0d1 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Thu, 20 Aug 2026 16:05:28 +0000 Subject: [PATCH 2/2] Add prerequisites and first-run login note to SDK quickstart --- fern/products/sdks/fern-folder.mdx | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/fern/products/sdks/fern-folder.mdx b/fern/products/sdks/fern-folder.mdx index 2a08d3bf5..86fa807d5 100644 --- a/fern/products/sdks/fern-folder.mdx +++ b/fern/products/sdks/fern-folder.mdx @@ -18,6 +18,12 @@ The goal of this page is speed — get the user to a working generated SDK as fa Generate an SDK with Fern. Follow the [SDKs quickstart](https://buildwithfern.com/learn/sdks/overview/quickstart.md) step by step. +## Prerequisites + +- [Node.js](https://nodejs.org) 18 or later, required to install the Fern CLI from npm +- An OpenAPI specification in JSON or YAML, or the Petstore example spec to follow along +- A Fern account, required by `fern generate`. [Sign up](https://buildwithfern.com) if you don't have one. + @@ -30,6 +36,8 @@ Generate an SDK with Fern. Follow the [SDKs quickstart](https://buildwithfern.co fern generate ``` + The first time you run `fern generate`, you must log in. Confirm the prompt and choose any of the login methods to authenticate, then generation continues automatically. + `fern generate` with no flags runs the `default-group` in `generators.yml`. The default init sets up a TypeScript SDK generator outputting to `local-file-system` at `../sdks/typescript`. The goal of this step is to get started quickly — the user will configure their target language in the language-specific quickstart. @@ -68,4 +76,4 @@ Now that you have a working SDK, set up GitHub repositories and configure publis Learn about Fern's multi-repo file structure and GitHub setup. - + \ No newline at end of file