Clarify prerequisites, org name, and login in SDK quickstarts - #6698
Open
fern-api[bot] wants to merge 2 commits into
Open
Clarify prerequisites, org name, and login in SDK quickstarts#6698fern-api[bot] wants to merge 2 commits into
fern-api[bot] wants to merge 2 commits into
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| </Step> | ||
| <Step title="Initialize the fern folder"> | ||
| 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 `<YourOrganization>` with the organization name on your Fern account, visible in the [Fern Dashboard](https://buildwithfern.com/dashboard). Organization names cannot contain spaces. |
Contributor
There was a problem hiding this comment.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'can't' instead of 'cannot'.
Suggested change
| Initialize the fern folder with your existing OpenAPI specification. Specify your organization name using the `--organization` flag. Replace `<YourOrganization>` with the organization name on your Fern account, visible in the [Fern Dashboard](https://buildwithfern.com/dashboard). Organization names cannot contain spaces. | |
| Initialize the fern folder with your existing OpenAPI specification. Specify your organization name using the `--organization` flag. Replace `<YourOrganization>` with the organization name on your Fern account, visible in the [Fern Dashboard](https://buildwithfern.com/dashboard). Organization names can't contain spaces. |
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-08-20-fern-ai-d8be69-b699122d.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Both SDK quickstarts now open with a Prerequisites list (Node.js 18+, an OpenAPI spec or the Petstore example, and a Fern account needed for
fern generate). The shared "Initialize the fern folder" step explains that<YourOrganization>is the organization name on your Fern account, visible in the Fern Dashboard, and cannot contain spaces. The SDK overview quickstart's Generate step documents the first-run login prompt, and the Ruby quickstart explains thegenerators.ymlsnippet:ruby-sdkis the group name passed to--group(and renameable),fern-ruby-sdkis Fern's official Ruby generator, andlocal-file-systemwrites tooutput.pathuntil you switch the location togithubto publish. The Ruby quickstart also now showsruby-sdkcorrectly nested under thegroups:top-level key.