-
Notifications
You must be signed in to change notification settings - Fork 3
Add Mintlify integration page for Fern #1787
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
dannysheridan
merged 6 commits into
main
from
devin/1762352751-mintlify-fern-integration
Nov 5, 2025
Merged
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e262a4d
Add Mintlify integration page for Fern
devin-ai-integration[bot] 5a2ff74
Fix Vale warning: remove time-relative term 'now'
devin-ai-integration[bot] 880388d
Rename integration from Fern to Mintlify
devin-ai-integration[bot] 1b8a7cb
Move Mintlify integration from sdks/ to docs/ subdirectory
devin-ai-integration[bot] f926562
Address PR feedback: remove slug and redirect
devin-ai-integration[bot] 6787aec
Remove /docs subdirectory from integrations path
devin-ai-integration[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated