Skip to content

Commit cbf7026

Browse files
authored
(sdks) Add link to example generated readme (#1232)
1 parent 85d588d commit cbf7026

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

fern/products/sdks/guides/configure-readme.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@ title: Customize README
33
description: Guide to configuring the README.md in SDKs
44
---
55

6-
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.
7-
8-
By default, Fern [generates the README automatically](./sdk-user-features) with usage examples and API details.
6+
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.
97

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

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

1614
## Additional customization
1715

18-
To go beyond the available configuration options, the `README.md` file can be [manually edited](/products/sdks/custom-code.mdx).
19-
Add it to the `.fernignore` file to prevent it from being overwritten during regeneration.
16+
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.

fern/products/sdks/guides/generated-sdk.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: How your customers can use your SDK
55

66
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).
77

8+
For a complete example of a generated SDK README, see [Intercom's Python SDK](https://github.com/intercom/python-intercom/blob/3aac991a92cefe34cf437f8f5ca46c97c04c1a6c/README.md).
9+
810
## Installation and basic usage
911

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

0 commit comments

Comments
 (0)