diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index a345e0789..bc88a309c 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -378,7 +378,7 @@ metadata: ## readme -Controls what goes into the generated README files across all SDKs. +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: @@ -401,31 +401,39 @@ readme: 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. - + + 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`). - + + Whether the endpoint is a streaming endpoint. Defaults to `false`. ## default-group