From 6c36a9176bdefc1154e8f7819ff2b9c4e9502fe6 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 11 Sep 2025 11:39:42 -0400 Subject: [PATCH 1/2] readme updates draft --- .../products/sdks/guides/configure-readme.mdx | 25 ++----- .../reference/generators-yml-reference.mdx | 68 +------------------ .../products/sdks/snippets/readme-options.mdx | 66 ++++++++++++++++++ 3 files changed, 74 insertions(+), 85 deletions(-) create mode 100644 fern/products/sdks/snippets/readme-options.mdx diff --git a/fern/products/sdks/guides/configure-readme.mdx b/fern/products/sdks/guides/configure-readme.mdx index 7be1b17b1..8f99f8f63 100644 --- a/fern/products/sdks/guides/configure-readme.mdx +++ b/fern/products/sdks/guides/configure-readme.mdx @@ -6,23 +6,10 @@ 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. -```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" -``` +## Configuration options -For more detailed information on `readme` configuration, see the [`generators.yml` documentation](/sdks/reference/generators-yml#readme) \ No newline at end of file + + +## Additional customization + +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. \ 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..97d7ebfde --- /dev/null +++ b/fern/products/sdks/snippets/readme-options.mdx @@ -0,0 +1,66 @@ +```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`). + + + + Whether the endpoint is a streaming endpoint. Defaults to `false`. + \ No newline at end of file From 034229dab7d39ecd690a5f6f762ec654eff53c75 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 12 Sep 2025 15:10:28 -0400 Subject: [PATCH 2/2] update wording --- fern/products/sdks/guides/configure-readme.mdx | 6 +++--- fern/products/sdks/snippets/readme-options.mdx | 11 ++++++----- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/fern/products/sdks/guides/configure-readme.mdx b/fern/products/sdks/guides/configure-readme.mdx index 8f99f8f63..14e5f9d69 100644 --- a/fern/products/sdks/guides/configure-readme.mdx +++ b/fern/products/sdks/guides/configure-readme.mdx @@ -3,8 +3,8 @@ 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`. + ## Configuration options @@ -12,4 +12,4 @@ You can add custom introductions, showcase key endpoints, and organize your SDK ## Additional customization -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. \ No newline at end of file +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/snippets/readme-options.mdx b/fern/products/sdks/snippets/readme-options.mdx index 97d7ebfde..73c967cbe 100644 --- a/fern/products/sdks/snippets/readme-options.mdx +++ b/fern/products/sdks/snippets/readme-options.mdx @@ -47,20 +47,21 @@ 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. + Organizes endpoints into named feature sections within the README. Each feature creates a dedicated section with example code snippets for the specified endpoints. -### defaultEndpoint +### 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