Skip to content

docs: add naming configuration for TypeScript SDK#4271

Merged
fern-support merged 3 commits intomainfrom
devin/1773442053-add-naming-config-docs
Mar 14, 2026
Merged

docs: add naming configuration for TypeScript SDK#4271
fern-support merged 3 commits intomainfrom
devin/1773442053-add-naming-config-docs

Conversation

@Swimburger
Copy link
Member

@Swimburger Swimburger commented Mar 13, 2026

docs: add naming configuration for TypeScript SDK

Summary

Adds documentation for the new naming configuration 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 existing namespaceExport documentation and includes:

  • A YAML + TypeScript example showing lowercase namespace with PascalCase overrides
  • A table documenting all 7 optional fields and their defaults
  • A note on backwards compatibility with namespaceExport

Review & Testing Checklist for Human

  • Verify the import example is accurate: The docs claim namespace: xai produces import { xai, XAiClient } from "xai". Confirm the code PR actually uses the raw namespace value (not PascalCased) as the module-level export name.
  • Check rendered table: Confirm the markdown table with 7 fields renders correctly on the preview deployment — markdown tables inside <ParamField> components can sometimes have rendering quirks.
  • Vale style check: Verify no Vale style violations are flagged in CI (sentence case, passive voice, etc.).

Test plan: Open the preview deployment, navigate to the TypeScript SDK configuration page, and confirm the new naming section appears between namespaceExport and neverThrowErrors with correct formatting.

Notes


Open with Devin

Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
@devin-ai-integration
Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link
Contributor

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2026

Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
```yaml title="generators.yml"
config:
naming:
namespace: xai
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't mention xai! use dummy data

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed — replaced xai with acme in the object form example.

Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
@fern-support fern-support merged commit 25ec614 into main Mar 14, 2026
2 checks passed
@fern-support fern-support deleted the devin/1773442053-add-naming-config-docs branch March 14, 2026 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants