From 84ca5fa185e50aa5b5c39e93d4f655fa49cfa36c Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 13 Oct 2025 12:04:16 -0400 Subject: [PATCH 1/2] add readme example --- fern/products/sdks/guides/configure-readme.mdx | 3 +-- fern/products/sdks/guides/generated-sdk.mdx | 2 ++ 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/fern/products/sdks/guides/configure-readme.mdx b/fern/products/sdks/guides/configure-readme.mdx index 37bd365dc..990087c3b 100644 --- a/fern/products/sdks/guides/configure-readme.mdx +++ b/fern/products/sdks/guides/configure-readme.mdx @@ -15,5 +15,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. diff --git a/fern/products/sdks/guides/generated-sdk.mdx b/fern/products/sdks/guides/generated-sdk.mdx index d1ed62a38..d7263ff4b 100644 --- a/fern/products/sdks/guides/generated-sdk.mdx +++ b/fern/products/sdks/guides/generated-sdk.mdx @@ -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. From ab45483b265cfdad4fba28c8dc796ba66f5435f7 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Mon, 13 Oct 2025 12:10:07 -0400 Subject: [PATCH 2/2] spacing nit --- fern/products/sdks/guides/configure-readme.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/fern/products/sdks/guides/configure-readme.mdx b/fern/products/sdks/guides/configure-readme.mdx index 990087c3b..60e879e1f 100644 --- a/fern/products/sdks/guides/configure-readme.mdx +++ b/fern/products/sdks/guides/configure-readme.mdx @@ -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.