Skip to content

(sdks) Add example link to README guide #1608

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 1 commit into from
Oct 30, 2025
Merged

(sdks) Add example link to README guide #1608

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion 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,7 +3,9 @@ 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 that 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. For a complete example of a generated SDK README, see [Intercom's Python SDK](https://github.com/intercom/python-intercom/blob/3aac991a92cefe34cf437f8f5ca46c97c04c1a6c/README.md).

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

Expand Down