docs: add naming configuration for TypeScript SDK#4271
Merged
fern-support merged 3 commits intomainfrom Mar 14, 2026
Merged
Conversation
Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-2812684e-d5bd-4efa-96c1-fa9091cff026.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
Swimburger
commented
Mar 14, 2026
| ```yaml title="generators.yml" | ||
| config: | ||
| naming: | ||
| namespace: xai |
Member
Author
There was a problem hiding this comment.
don't mention xai! use dummy data
Contributor
There was a problem hiding this comment.
Fixed — replaced xai with acme in the object form example.
Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
fern-support
approved these changes
Mar 14, 2026
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.
docs: add naming configuration for TypeScript SDK
Summary
Adds documentation for the new
namingconfiguration object in the TypeScript SDK generator (corresponding code change: fern-api/fern#13545). This config allows users to independently control the namespace export and PascalCase class/type names (client, error, timeout error, environment, environment URLs, version).The new
<ParamField>block is placed immediately after the existingnamespaceExportdocumentation and includes:namespaceExportReview & Testing Checklist for Human
namespace: xaiproducesimport { xai, XAiClient } from "xai". Confirm the code PR actually uses the rawnamespacevalue (not PascalCased) as the module-level export name.<ParamField>components can sometimes have rendering quirks.Test plan: Open the preview deployment, navigate to the TypeScript SDK configuration page, and confirm the new
namingsection appears betweennamespaceExportandneverThrowErrorswith correct formatting.Notes