diff --git a/fern/products/sdks/guides/configure-readme.mdx b/fern/products/sdks/guides/configure-readme.mdx
index 7be1b17b1..14e5f9d69 100644
--- a/fern/products/sdks/guides/configure-readme.mdx
+++ b/fern/products/sdks/guides/configure-readme.mdx
@@ -3,26 +3,13 @@ title: Customize README
description: Guide to configuring the README in your SDK
---
-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.
-You can add custom introductions, showcase key endpoints, and organize your SDK documentation with feature sections.
+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`.
-```yaml title="generators.yml"
-readme:
- introduction: "Welcome to our API"
- apiReferenceLink: "https://docs.example.com"
- apiName: "Example Product"
- disabledSections:
- - "contributing"
- defaultEndpoint:
- method: "POST"
- path: "/users"
- features:
- authentication:
- - method: "POST"
- path: "/auth/login"
- users:
- - method: "GET"
- path: "/users"
-```
-For more detailed information on `readme` configuration, see the [`generators.yml` documentation](/sdks/reference/generators-yml#readme)
\ No newline at end of file
+## Configuration options
+
+
+
+## Additional customization
+
+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.
\ No newline at end of file
diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx
index 41a2eb625..921814914 100644
--- a/fern/products/sdks/reference/generators-yml-reference.mdx
+++ b/fern/products/sdks/reference/generators-yml-reference.mdx
@@ -330,74 +330,10 @@ metadata:
## readme
-Controls what goes into the generated README files across all SDKs, allowing you to customize the content and structure of your SDK documentation.
-
-```yaml
-readme:
- bannerLink: "https://example.com/banner"
- introduction: "Welcome to our API"
- apiReferenceLink: "https://docs.example.com"
- apiName: "Example Product"
- disabledSections:
- - "contributing"
- defaultEndpoint:
- method: "POST"
- path: "/users"
- stream: false
- features:
- authentication:
- - method: "POST"
- path: "/auth/login"
- - "GET /auth/profile"
- users:
- - method: "GET"
- path: "/users"
- - method: "POST"
- path: "/users"
-```
-
-
- URL for a banner image or link that appears at the top of the README.
-
-
-
- Custom introduction text that appears at the beginning of the README.
-
-
-
- URL to your external API documentation or reference guide.
-
-
-
- Name of the API that appears in the README. Will appear as `Your Api Name SDK` or `Your Api Name API` throughout the README. Defaults to organization name if not set.
-
-
-
- Sections to disable in the README. Supported values: `"contributing"`.
-
-
-
- Specifies which endpoint's code snippet to showcase as the primary example in the README.
-
-
-
- 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.
-
-
-### defaultEndpoint
-Specifies which endpoint's code snippet to showcase as the primary example in the README.
-
-
- HTTP method of the default endpoint (e.g., `GET`, `POST`, `PUT`, `DELETE`).
-
-
- Endpoint path for the default example (e.g., `/users`, `/auth/login`).
-
+Controls what goes into the generated README files across all SDKs, allowing you to customize the content and structure of your SDK documentation.
-
- Whether the endpoint is a streaming endpoint. Defaults to `false`.
-
+
## default-group
Which group to use when none is specified.
diff --git a/fern/products/sdks/snippets/readme-options.mdx b/fern/products/sdks/snippets/readme-options.mdx
new file mode 100644
index 000000000..73c967cbe
--- /dev/null
+++ b/fern/products/sdks/snippets/readme-options.mdx
@@ -0,0 +1,67 @@
+```yaml
+readme:
+ bannerLink: "https://example.com/banner"
+ introduction: "Welcome to our API"
+ apiReferenceLink: "https://docs.example.com"
+ apiName: "Example Product"
+ disabledSections:
+ - "contributing"
+ defaultEndpoint:
+ method: "POST"
+ path: "/users"
+ stream: false
+ features:
+ authentication:
+ - method: "POST"
+ path: "/auth/login"
+ - "GET /auth/profile"
+ users:
+ - method: "GET"
+ path: "/users"
+ - method: "POST"
+ path: "/users"
+```
+
+
+ URL for a banner image or link that appears at the top of the README.
+
+
+
+ Custom introduction text that appears at the beginning of the README.
+
+
+
+ URL to your external API documentation or reference guide.
+
+
+
+ Name of the API that appears in the README. Will appear as `Your Api Name SDK` or `Your Api Name API` throughout the README. Defaults to organization name if not set.
+
+
+
+ Sections to disable in the README. Supported values: `"contributing"`.
+
+
+
+ Specifies which endpoint's code snippet to showcase as the primary example in the README.
+
+
+
+ Organizes endpoints into named feature sections within the README. Each feature creates a dedicated section with example code snippets for the specified endpoints.
+
+
+### Endpoint configuration
+
+Specifies which endpoint's code snippet to showcase as the primary example in the README.
+
+
+ HTTP method of the default endpoint (e.g., `GET`, `POST`, `PUT`, `DELETE`).
+
+
+
+ Endpoint path for the default example (e.g., `/users`, `/auth/login`).
+
+
+
+ Whether the endpoint is a streaming endpoint. Defaults to `false`.
+
\ No newline at end of file