Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

undo this change

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
Expand Down
3 changes: 3 additions & 0 deletions fern/products/docs/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,9 @@ navigation:
slug: analytics/mixpanel
- page: Postman
path: ./pages/integrations/postman.mdx
- page: Mintlify
path: ./pages/integrations/docs/mintlify.mdx
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Get rid of /docs here

slug: docs/mintlify
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove slug

- page: LaunchDarkly feature flags
path: ./pages/integrations/feature-flags.mdx
hidden: true
Expand Down
28 changes: 28 additions & 0 deletions fern/products/docs/pages/integrations/docs/mintlify.mdx
Original file line number Diff line number Diff line change
@@ -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`.
10 changes: 9 additions & 1 deletion fern/products/docs/pages/integrations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ description: "Integrate with third party platforms for analytics, support, etc."
iconSize={12}
/>

<Card
title="Mintlify"
href="/docs/integrations/docs/mintlify"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No /docs

horizontal
icon={<img src="https://mintcdn.com/mintlify/e0-N9JebsJpsinlD/logo/light.svg" />}
iconSize={12}
/>

</CardGroup>

## Enabling Analytics
Expand Down Expand Up @@ -99,4 +107,4 @@ are available during the workflow run.

<Markdown src="/snippets/enterprise-plan.mdx"/>

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).
Loading