Skip to content

Commit 1b8a7cb

Browse files
Move Mintlify integration from sdks/ to docs/ subdirectory
- 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: [email protected] <[email protected]>
1 parent 880388d commit 1b8a7cb

File tree

5 files changed

+34
-68
lines changed

5 files changed

+34
-68
lines changed

fern/docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -551,6 +551,8 @@ redirects:
551551
destination: /learn/docs/getting-started/project-structure
552552
- source: /learn/docs/alternatives/mintlify
553553
destination: /learn/docs/getting-started/overview
554+
- source: /learn/docs/integrations/sdks/mintlify
555+
destination: /learn/docs/integrations/docs/mintlify
554556
- source: /learn/docs/api-references/api-explorer/advanced-configuration
555557
destination: /learn/docs/api-references/api-explorer/overview
556558
- source: /learn/docs/enterprise/self-hosted

fern/products/docs/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,8 +270,8 @@ navigation:
270270
- page: Postman
271271
path: ./pages/integrations/postman.mdx
272272
- page: Mintlify
273-
path: ./pages/integrations/sdks/mintlify.mdx
274-
slug: sdks/mintlify
273+
path: ./pages/integrations/docs/mintlify.mdx
274+
slug: docs/mintlify
275275
- page: LaunchDarkly feature flags
276276
path: ./pages/integrations/feature-flags.mdx
277277
hidden: true
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Mintlify"
3+
description: "Generate SDKs with Fern and document them with Mintlify"
4+
---
5+
6+
Use Fern to generate SDKs for your API, then document them in Mintlify with automatically enriched code samples.
7+
8+
## How it works
9+
10+
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.
11+
12+
## Setup
13+
14+
Add the Fern OpenAPI spec URL to your Mintlify `docs.json` configuration:
15+
16+
```json docs.json
17+
{
18+
"anchors": [
19+
{
20+
"name": "API Reference",
21+
"openapi": "https://registry.buildwithfern.com/{org}/{api-name}/openapi/openapi.json",
22+
"url": "api-reference"
23+
}
24+
]
25+
}
26+
```
27+
28+
Replace `{org}` with your organization name and `{api-name}` with your API name from `fern.config.json`.

fern/products/docs/pages/integrations/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ description: "Integrate with third party platforms for analytics, support, etc."
4949

5050
<Card
5151
title="Mintlify"
52-
href="/docs/integrations/sdks/mintlify"
52+
href="/docs/integrations/docs/mintlify"
5353
horizontal
5454
icon={<img src="https://mintcdn.com/mintlify/e0-N9JebsJpsinlD/logo/light.svg" />}
5555
iconSize={12}
@@ -107,4 +107,4 @@ are available during the workflow run.
107107

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

110-
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).
110+
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).

fern/products/docs/pages/integrations/sdks/mintlify.mdx

Lines changed: 0 additions & 64 deletions
This file was deleted.

0 commit comments

Comments
 (0)