Skip to content

Commit 034229d

Browse files
committed
update wording
1 parent 6c36a91 commit 034229d

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: Customize README
33
description: Guide to configuring the README in your SDK
44
---
55

6-
By default, the README for your SDKs is generated programmatically. You can override this by configuring the `readme` section in `generators.yml` to control the content and structure of generated README files across all your SDKs.
7-
You can add custom introductions, showcase key endpoints, and organize your SDK documentation with feature sections.
6+
By default, the README for your SDKs is generated programmatically. You can customize the content and structure of these README files across all of your SDKs by configuring the `readme` section in `generators.yml`.
7+
88

99
## Configuration options
1010

1111
<Markdown src="/products/sdks/snippets/readme-options.mdx" />
1212

1313
## Additional customization
1414

15-
If you want to customize the README further than the allowed configuration options, you can [manually modify the readme](/products/sdks/custom-code.mdx), then add it to your `.fernignore` file so it doesn't get overwritten on regenerations.
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.

fern/products/sdks/snippets/readme-options.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,20 +47,21 @@ readme:
4747
</ParamField>
4848

4949
<ParamField path="features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
50-
Groups endpoints by feature name for organized README sections. Each feature becomes a section in the README with example code snippets for the listed endpoints.
50+
Organizes endpoints into named feature sections within the README. Each feature creates a dedicated section with example code snippets for the specified endpoints.
5151
</ParamField>
5252

53-
### defaultEndpoint
53+
### Endpoint configuration
54+
5455
Specifies which endpoint's code snippet to showcase as the primary example in the README.
5556

56-
<ParamField path="method" type="string" required={true} toc={true}>
57+
<ParamField path="defaultEndpoint.method" type="string" required={true} toc={true}>
5758
HTTP method of the default endpoint (e.g., `GET`, `POST`, `PUT`, `DELETE`).
5859
</ParamField>
5960

60-
<ParamField path="path" type="string" required={true} toc={true}>
61+
<ParamField path="defaultEndpoint.path" type="string" required={true} toc={true}>
6162
Endpoint path for the default example (e.g., `/users`, `/auth/login`).
6263
</ParamField>
6364

64-
<ParamField path="stream" type="boolean" required={false} default="false" toc={true}>
65+
<ParamField path="defaultEndpoint.stream" type="boolean" required={false} default="false" toc={true}>
6566
Whether the endpoint is a streaming endpoint. Defaults to `false`.
6667
</ParamField>

0 commit comments

Comments
 (0)