diff --git a/fern/products/sdks/guides/configure-readme.mdx b/fern/products/sdks/guides/configure-readme.mdx index fcbcaf29..980cc696 100644 --- a/fern/products/sdks/guides/configure-readme.mdx +++ b/fern/products/sdks/guides/configure-readme.mdx @@ -3,8 +3,11 @@ 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 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. + +We also include templates for README generation + +> The readme is super customizable ```yaml title="generators.yml" readme: @@ -22,4 +25,4 @@ readme: 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 +For more detailed information on `readme` configuration, see the `generators.yml`[ documentation](/sdks/reference/generators-yml#readme)