Skip to content

(sdks) Add link to example generated readme #1232

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.

Sign up for GitHub

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 2 commits into from
Oct 13, 2025
Merged

(sdks) Add link to example generated readme #1232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84ca5fa
add readme example
devalog Oct 13, 2025
ab45483
spacing nit
devalog Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions fern/products/sdks/guides/configure-readme.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ title: Customize README
description: Guide to configuring the README.md in SDKs
---

Each SDK includes a `README.md` file in its root directory. This Markdown file provides an overview of the SDK and instructions for working with the associated API.

By default, Fern [generates the README automatically](./sdk-user-features) with usage examples and API details.
Each SDK includes a `README.md` file in its root directory. This Markdown file provides an overview of the SDK and instructions for working with the associated API. By default, Fern [generates the README automatically](./sdk-user-features) with usage examples and API details.

Although each SDK has its own README, the content can be configured globally through the `readme` section in the `generators.yml` file.

Expand All @@ -15,5 +13,4 @@ Although each SDK has its own README, the content can be configured globally thr

## Additional customization

To go beyond the available configuration options, the `README.md` file can be [manually edited](/products/sdks/custom-code.mdx).
Add it to the `.fernignore` file to prevent it from being overwritten during regeneration.
To go beyond the available configuration options, you can [manually edit the `README.md` file](/products/sdks/custom-code.mdx). Then, add it to the `.fernignore` file to prevent it from being overwritten during regeneration.
2 changes: 2 additions & 0 deletions fern/products/sdks/guides/generated-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: How your customers can use your SDK

Fern-generated SDKs provide a consistent set of features across all languages to help developers interact with your API. Usage information is auto-generated in your SDK's `README.md`, [which you can customize](./readme).

For a complete example of a generated SDK README, see [Intercom's Python SDK](https://github.com/intercom/python-intercom/blob/3aac991a92cefe34cf437f8f5ca46c97c04c1a6c/README.md).

## Installation and basic usage

Users install SDKs using standard package managers (npm for TypeScript, pip for Python, Maven/Gradle for Java, etc.) from language-specific registries.
Expand Down