Skip to content

Commit d36ea10

Browse files
(sdks) Document auto-generated reference.md file, clarify README.md info (#1218)
Co-authored-by: Danny Sheridan <[email protected]>
1 parent f901df9 commit d36ea10

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed
Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
---
22
title: Customize README
3-
description: Guide to configuring the README in your SDK
3+
description: Guide to configuring the README.md in SDKs
44
---
55

6-
By default, the README for your SDKs is [generated programmatically](./sdk-user-features) and contains information about how your users can interact with your API. You can customize the content and structure of these README files across all of your SDKs by configuring the `readme` section in `generators.yml`.
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.
77

8+
By default, Fern [generates the README automatically](./sdk-user-features) with usage examples and API details.
9+
10+
Although each SDK has its own README, the content can be configured globally through the `readme` section in the `generators.yml` file.
811

912
## Configuration options
1013

1114
<Markdown src="/products/sdks/snippets/readme-options.mdx" />
1215

1316
## Additional customization
1417

15-
For customization beyond these configuration options, you can [manually modify the README](/products/sdks/custom-code.mdx) and add it to your `.fernignore` file to prevent it from being overwritten during regeneration.
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.

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,22 @@ title: SDK user features
33
description: How your customers can use your SDK
44
---
55

6-
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, [which you can customize](./readme).
6+
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

88
## Installation and basic usage
99

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

1212
Users initialize the client with your API's base URL and any required authentication, then call methods on the client to interact with your API. Generated SDKs support modern runtimes across languages.
1313

14+
## Reference
15+
16+
The `README.md` file links to an auto-generated `reference.md` file
17+
([example](https://github.com/intercom/python-intercom/blob/HEAD/reference.md))
18+
that lists all available API methods organized by resource, including method
19+
signatures with parameter types, usage examples, and request/response structures
20+
for each endpoint.
21+
1422
## Error handling
1523

1624
When the API returns a 4xx or 5xx status code, the SDK throws an error that includes the status code, error message, response body, and raw response object.

0 commit comments

Comments
 (0)