-
Notifications
You must be signed in to change notification settings - Fork 3
Make various edits to Go and PHP docs based on feedback #125
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f92d8a8
go edits
devalog 5fb74c7
update all quickstarts with language-sdk command format and note
devalog 4f21edc
various small updates
devalog 3a189bf
take out internal prefix
devalog fb14e0d
update links and terminology in go publishing guide
devalog d6be640
minor additional edits
devalog 321e6d1
edit
devalog File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,7 @@ description: Get started quickly with the Fern Go SDK. | |
|
|
||
| Generate a Go SDK by following the instructions on this page. | ||
|
|
||
| <Markdown src="/products/sdks/snippets/quickstart-prereqs.mdx"/> | ||
| <Markdown src="/products/sdks/snippets/setup-fern-folder-callout.mdx"/> | ||
|
|
||
| <Steps> | ||
|
|
||
|
|
@@ -16,13 +16,19 @@ Generate a Go SDK by following the instructions on this page. | |
| Add the Go SDK generator: | ||
|
|
||
| ```bash | ||
| fern add fern-go-sdk --group sdk | ||
| fern add fern-go-sdk --group go-sdk | ||
| ``` | ||
| <Note> | ||
| `go-sdk` is the name of the `generators.yml` group that configures your Go | ||
| SDK's output location and other metadata. You can customize this group name to | ||
| differentiate between multiple SDKs across different languages (e.g., | ||
| `internal-go-sdk`, `ruby-sdk`, etc) in your organization. | ||
|
||
| </Note> | ||
|
|
||
| This command adds the following to `generators.yml`: | ||
|
|
||
| ```yaml | ||
| sdk: | ||
| go-sdk: | ||
| generators: | ||
| - name: fernapi/fern-go-sdk | ||
| version: <Markdown src="/snippets/version-number.mdx"/> | ||
|
|
@@ -31,13 +37,21 @@ This command adds the following to `generators.yml`: | |
| path: ../sdks/go | ||
| ``` | ||
|
|
||
| <Markdown src="/products/sdks/snippets/generate-sdk.mdx"/> | ||
| ### Generate the SDK | ||
|
|
||
| Generate the SDK: | ||
|
|
||
| ```bash | ||
| fern generate --group go-sdk | ||
| ``` | ||
|
|
||
| <Markdown src="/products/sdks/snippets/generate-sdk.mdx"/> | ||
|
|
||
| ```bash | ||
| fern/ # created by fern init | ||
| sdks/ # created by fern generate --group sdk | ||
| sdks/ # created by fern generate --group go-sdk | ||
| ├─ go | ||
| ├─ core/ | ||
| └─ resources/ | ||
devalog marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| └─ go.mod | ||
| ``` | ||
| </Steps> | ||
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.