From e262a4d35f06e5ae923ba73721cf190fc8a01e01 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 14:26:16 +0000 Subject: [PATCH 1/6] Add Mintlify integration page for Fern - Create new integration page at fern/products/docs/pages/integrations/sdks/fern.mdx - Add navigation entry in docs.yml - Add Fern card to integrations overview page - Follow pattern from Speakeasy and Stainless integration pages Co-Authored-By: danny@buildwithfern.com --- fern/products/docs/docs.yml | 3 + .../docs/pages/integrations/overview.mdx | 10 ++- .../docs/pages/integrations/sdks/fern.mdx | 64 +++++++++++++++++++ 3 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 fern/products/docs/pages/integrations/sdks/fern.mdx diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 4e17e4fc9..f900e853b 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -269,6 +269,9 @@ navigation: slug: analytics/mixpanel - page: Postman path: ./pages/integrations/postman.mdx + - page: Fern + path: ./pages/integrations/sdks/fern.mdx + slug: sdks/fern - page: LaunchDarkly feature flags path: ./pages/integrations/feature-flags.mdx hidden: true diff --git a/fern/products/docs/pages/integrations/overview.mdx b/fern/products/docs/pages/integrations/overview.mdx index d2b0ec19f..3a4af2e7d 100644 --- a/fern/products/docs/pages/integrations/overview.mdx +++ b/fern/products/docs/pages/integrations/overview.mdx @@ -47,6 +47,14 @@ description: "Integrate with third party platforms for analytics, support, etc." iconSize={12} /> +} + iconSize={12} +/> + ## Enabling Analytics @@ -99,4 +107,4 @@ are available during the workflow run. -If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript). +If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript). diff --git a/fern/products/docs/pages/integrations/sdks/fern.mdx b/fern/products/docs/pages/integrations/sdks/fern.mdx new file mode 100644 index 000000000..7c182f2db --- /dev/null +++ b/fern/products/docs/pages/integrations/sdks/fern.mdx @@ -0,0 +1,64 @@ +--- +title: "Fern" +description: "Automate SDK code snippets in your API playground" +--- + +Fern offers a publicly accessible URL with an OpenAPI spec enriched with code samples from generated SDKs. SDK usage snippets are automatically included in the [interactive playground](/docs/api-references/api-explorer) of Mintlify-powered documentation sites. + +## Prerequisites + +To integrate Mintlify with Fern, you'll need the following: + +- A [Mintlify documentation repository](/docs/quickstart#creating-the-repository). +- A Fern-generated API definition with SDK generators configured in [`generators.yml`](/sdks/reference/generators-yml). + +## Setting up the integration + +To integrate Fern with Mintlify, you must get your API's OpenAPI spec URL from Fern and update your `docs.json` configuration file. + +### Get your OpenAPI spec URL from Fern + +Fern automatically generates a publicly accessible OpenAPI spec enriched with SDK code samples. The URL follows this pattern: + +``` +https://registry.buildwithfern.com/api-name/openapi/openapi.json +``` + +Replace `api-name` with your Fern API name. You can find your API name in your `fern.config.json` file. + +### Update your `docs.json` configuration file + +Add the Fern OpenAPI spec URL to an **Anchors** or **Tabs** section in your `docs.json` file. + +Add the OpenAPI spec URL to an anchor by updating the `anchor` field in your `docs.json` file as follows: + +```json docs.json +{ + "anchors": [ + { + "name": "API Reference", + // !mark + "openapi": "https://registry.buildwithfern.com/api-name/openapi/openapi.json", + "url": "api-reference", + "icon": "square-terminal" + } + ] +} +``` + +Add the OpenAPI spec URL to a tab by updating the `tab` field in the `docs.json` file as follows: + +```json docs.json +{ + "tabs": [ + { + "name": "API Reference", + "url": "api-reference", + // !mark + "openapi": "https://registry.buildwithfern.com/api-name/openapi/openapi.json" + } + ] +} +``` + +Fern-generated code snippets can now be viewed in your API docs and interacted with in the playground. From 5a2ff74840dcb247e72cfe110b4f711f6ce98875 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 14:31:15 +0000 Subject: [PATCH 2/6] Fix Vale warning: remove time-relative term 'now' Co-Authored-By: danny@buildwithfern.com --- fern/products/docs/pages/integrations/sdks/fern.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/integrations/sdks/fern.mdx b/fern/products/docs/pages/integrations/sdks/fern.mdx index 7c182f2db..e2d9de1b4 100644 --- a/fern/products/docs/pages/integrations/sdks/fern.mdx +++ b/fern/products/docs/pages/integrations/sdks/fern.mdx @@ -61,4 +61,4 @@ Add the OpenAPI spec URL to a tab by updating the `tab` field in the `docs.json` } ``` -Fern-generated code snippets can now be viewed in your API docs and interacted with in the playground. +Fern-generated code snippets can be viewed in your API docs and interacted with in the playground. From 880388d78357156fba866b9e90c8995306f8f6ec Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 14:53:15 +0000 Subject: [PATCH 3/6] Rename integration from Fern to Mintlify - Rename file from fern.mdx to mintlify.mdx - Update page title to 'Mintlify' - Update navigation entry in docs.yml - Update overview page card with Mintlify branding - Update slug from sdks/fern to sdks/mintlify Co-Authored-By: danny@buildwithfern.com --- fern/products/docs/docs.yml | 6 +++--- fern/products/docs/pages/integrations/overview.mdx | 8 ++++---- .../pages/integrations/sdks/{fern.mdx => mintlify.mdx} | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) rename fern/products/docs/pages/integrations/sdks/{fern.mdx => mintlify.mdx} (99%) diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index f900e853b..56ede196f 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -269,9 +269,9 @@ navigation: slug: analytics/mixpanel - page: Postman path: ./pages/integrations/postman.mdx - - page: Fern - path: ./pages/integrations/sdks/fern.mdx - slug: sdks/fern + - page: Mintlify + path: ./pages/integrations/sdks/mintlify.mdx + slug: sdks/mintlify - page: LaunchDarkly feature flags path: ./pages/integrations/feature-flags.mdx hidden: true diff --git a/fern/products/docs/pages/integrations/overview.mdx b/fern/products/docs/pages/integrations/overview.mdx index 3a4af2e7d..609c5b36c 100644 --- a/fern/products/docs/pages/integrations/overview.mdx +++ b/fern/products/docs/pages/integrations/overview.mdx @@ -48,10 +48,10 @@ description: "Integrate with third party platforms for analytics, support, etc." /> } + icon={} iconSize={12} /> @@ -107,4 +107,4 @@ are available during the workflow run. -If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript). +If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript). diff --git a/fern/products/docs/pages/integrations/sdks/fern.mdx b/fern/products/docs/pages/integrations/sdks/mintlify.mdx similarity index 99% rename from fern/products/docs/pages/integrations/sdks/fern.mdx rename to fern/products/docs/pages/integrations/sdks/mintlify.mdx index e2d9de1b4..2e136b44f 100644 --- a/fern/products/docs/pages/integrations/sdks/fern.mdx +++ b/fern/products/docs/pages/integrations/sdks/mintlify.mdx @@ -1,5 +1,5 @@ --- -title: "Fern" +title: "Mintlify" description: "Automate SDK code snippets in your API playground" --- From 1b8a7cb049bec652707450c53fabd5028c5c7dfe Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 18:18:35 +0000 Subject: [PATCH 4/6] Move Mintlify integration from sdks/ to docs/ subdirectory MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Move mintlify.mdx from integrations/sdks/ to integrations/docs/ - Update content to be concise: generate SDKs with Fern → document with Mintlify - Update navigation in docs.yml to point to new docs/ location - Update overview page card href to new docs/ location - Add redirect from old /sdks/mintlify path to new /docs/mintlify path Co-Authored-By: danny@buildwithfern.com --- fern/docs.yml | 2 + fern/products/docs/docs.yml | 4 +- .../docs/pages/integrations/docs/mintlify.mdx | 28 ++++++++ .../docs/pages/integrations/overview.mdx | 4 +- .../docs/pages/integrations/sdks/mintlify.mdx | 64 ------------------- 5 files changed, 34 insertions(+), 68 deletions(-) create mode 100644 fern/products/docs/pages/integrations/docs/mintlify.mdx delete mode 100644 fern/products/docs/pages/integrations/sdks/mintlify.mdx diff --git a/fern/docs.yml b/fern/docs.yml index d246f923e..4c20476cf 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -551,6 +551,8 @@ redirects: destination: /learn/docs/getting-started/project-structure - source: /learn/docs/alternatives/mintlify destination: /learn/docs/getting-started/overview + - source: /learn/docs/integrations/sdks/mintlify + destination: /learn/docs/integrations/docs/mintlify - source: /learn/docs/api-references/api-explorer/advanced-configuration destination: /learn/docs/api-references/api-explorer/overview - source: /learn/docs/enterprise/self-hosted diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 56ede196f..db2bc99a1 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -270,8 +270,8 @@ navigation: - page: Postman path: ./pages/integrations/postman.mdx - page: Mintlify - path: ./pages/integrations/sdks/mintlify.mdx - slug: sdks/mintlify + path: ./pages/integrations/docs/mintlify.mdx + slug: docs/mintlify - page: LaunchDarkly feature flags path: ./pages/integrations/feature-flags.mdx hidden: true diff --git a/fern/products/docs/pages/integrations/docs/mintlify.mdx b/fern/products/docs/pages/integrations/docs/mintlify.mdx new file mode 100644 index 000000000..0c675fc31 --- /dev/null +++ b/fern/products/docs/pages/integrations/docs/mintlify.mdx @@ -0,0 +1,28 @@ +--- +title: "Mintlify" +description: "Generate SDKs with Fern and document them with Mintlify" +--- + +Use Fern to generate SDKs for your API, then document them in Mintlify with automatically enriched code samples. + +## How it works + +Fern generates SDKs and provides a publicly accessible OpenAPI spec enriched with SDK code samples. Reference this spec in your Mintlify documentation to display SDK usage examples in your API playground. + +## Setup + +Add the Fern OpenAPI spec URL to your Mintlify `docs.json` configuration: + +```json docs.json +{ + "anchors": [ + { + "name": "API Reference", + "openapi": "https://registry.buildwithfern.com/{org}/{api-name}/openapi/openapi.json", + "url": "api-reference" + } + ] +} +``` + +Replace `{org}` with your organization name and `{api-name}` with your API name from `fern.config.json`. diff --git a/fern/products/docs/pages/integrations/overview.mdx b/fern/products/docs/pages/integrations/overview.mdx index 609c5b36c..3d0fb0f2b 100644 --- a/fern/products/docs/pages/integrations/overview.mdx +++ b/fern/products/docs/pages/integrations/overview.mdx @@ -49,7 +49,7 @@ description: "Integrate with third party platforms for analytics, support, etc." } iconSize={12} @@ -107,4 +107,4 @@ are available during the workflow run. -If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript). +If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript). diff --git a/fern/products/docs/pages/integrations/sdks/mintlify.mdx b/fern/products/docs/pages/integrations/sdks/mintlify.mdx deleted file mode 100644 index 2e136b44f..000000000 --- a/fern/products/docs/pages/integrations/sdks/mintlify.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "Mintlify" -description: "Automate SDK code snippets in your API playground" ---- - -Fern offers a publicly accessible URL with an OpenAPI spec enriched with code samples from generated SDKs. SDK usage snippets are automatically included in the [interactive playground](/docs/api-references/api-explorer) of Mintlify-powered documentation sites. - -## Prerequisites - -To integrate Mintlify with Fern, you'll need the following: - -- A [Mintlify documentation repository](/docs/quickstart#creating-the-repository). -- A Fern-generated API definition with SDK generators configured in [`generators.yml`](/sdks/reference/generators-yml). - -## Setting up the integration - -To integrate Fern with Mintlify, you must get your API's OpenAPI spec URL from Fern and update your `docs.json` configuration file. - -### Get your OpenAPI spec URL from Fern - -Fern automatically generates a publicly accessible OpenAPI spec enriched with SDK code samples. The URL follows this pattern: - -``` -https://registry.buildwithfern.com/api-name/openapi/openapi.json -``` - -Replace `api-name` with your Fern API name. You can find your API name in your `fern.config.json` file. - -### Update your `docs.json` configuration file - -Add the Fern OpenAPI spec URL to an **Anchors** or **Tabs** section in your `docs.json` file. - -Add the OpenAPI spec URL to an anchor by updating the `anchor` field in your `docs.json` file as follows: - -```json docs.json -{ - "anchors": [ - { - "name": "API Reference", - // !mark - "openapi": "https://registry.buildwithfern.com/api-name/openapi/openapi.json", - "url": "api-reference", - "icon": "square-terminal" - } - ] -} -``` - -Add the OpenAPI spec URL to a tab by updating the `tab` field in the `docs.json` file as follows: - -```json docs.json -{ - "tabs": [ - { - "name": "API Reference", - "url": "api-reference", - // !mark - "openapi": "https://registry.buildwithfern.com/api-name/openapi/openapi.json" - } - ] -} -``` - -Fern-generated code snippets can be viewed in your API docs and interacted with in the playground. From f926562a09321b022d11cdda1068a9fbaad774d7 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 18:24:25 +0000 Subject: [PATCH 5/6] Address PR feedback: remove slug and redirect - Remove slug: docs/mintlify from navigation - Remove redirect from /integrations/sdks/mintlify to /integrations/docs/mintlify Co-Authored-By: danny@buildwithfern.com --- fern/docs.yml | 2 -- fern/products/docs/docs.yml | 1 - 2 files changed, 3 deletions(-) diff --git a/fern/docs.yml b/fern/docs.yml index 4c20476cf..d246f923e 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -551,8 +551,6 @@ redirects: destination: /learn/docs/getting-started/project-structure - source: /learn/docs/alternatives/mintlify destination: /learn/docs/getting-started/overview - - source: /learn/docs/integrations/sdks/mintlify - destination: /learn/docs/integrations/docs/mintlify - source: /learn/docs/api-references/api-explorer/advanced-configuration destination: /learn/docs/api-references/api-explorer/overview - source: /learn/docs/enterprise/self-hosted diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index db2bc99a1..8ee6e2bec 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -271,7 +271,6 @@ navigation: path: ./pages/integrations/postman.mdx - page: Mintlify path: ./pages/integrations/docs/mintlify.mdx - slug: docs/mintlify - page: LaunchDarkly feature flags path: ./pages/integrations/feature-flags.mdx hidden: true From 6787aecd67a37427c911a28a38f21bf9a733f268 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 19:41:51 +0000 Subject: [PATCH 6/6] Remove /docs subdirectory from integrations path - Move mintlify.mdx from integrations/docs/ to integrations/ - Update navigation path in docs.yml - Update overview card href from /docs/integrations/docs/mintlify to /docs/integrations/mintlify Co-Authored-By: danny@buildwithfern.com --- fern/products/docs/docs.yml | 2 +- fern/products/docs/pages/integrations/{docs => }/mintlify.mdx | 0 fern/products/docs/pages/integrations/overview.mdx | 4 ++-- 3 files changed, 3 insertions(+), 3 deletions(-) rename fern/products/docs/pages/integrations/{docs => }/mintlify.mdx (100%) diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 8ee6e2bec..b0b49246b 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -270,7 +270,7 @@ navigation: - page: Postman path: ./pages/integrations/postman.mdx - page: Mintlify - path: ./pages/integrations/docs/mintlify.mdx + path: ./pages/integrations/mintlify.mdx - page: LaunchDarkly feature flags path: ./pages/integrations/feature-flags.mdx hidden: true diff --git a/fern/products/docs/pages/integrations/docs/mintlify.mdx b/fern/products/docs/pages/integrations/mintlify.mdx similarity index 100% rename from fern/products/docs/pages/integrations/docs/mintlify.mdx rename to fern/products/docs/pages/integrations/mintlify.mdx diff --git a/fern/products/docs/pages/integrations/overview.mdx b/fern/products/docs/pages/integrations/overview.mdx index 3d0fb0f2b..a5830efcf 100644 --- a/fern/products/docs/pages/integrations/overview.mdx +++ b/fern/products/docs/pages/integrations/overview.mdx @@ -49,7 +49,7 @@ description: "Integrate with third party platforms for analytics, support, etc." } iconSize={12} @@ -107,4 +107,4 @@ are available during the workflow run. -If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript). +If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript).