-
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
Add Mintlify integration page for Fern #1787
Conversation
- 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 <danny@buildwithfern.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
| } | ||
| ``` | ||
|
|
||
| Fern-generated code snippets can now be viewed in your API docs and interacted with in the playground. |
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
Co-Authored-By: danny@buildwithfern.com <danny@buildwithfern.com>
- 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 <danny@buildwithfern.com>
- 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 <danny@buildwithfern.com>
fern/docs.yml
Outdated
| destination: /learn/docs/getting-started/project-structure | ||
| - source: /learn/docs/alternatives/mintlify | ||
| destination: /learn/docs/getting-started/overview | ||
| - source: /learn/docs/integrations/sdks/mintlify |
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.
undo this change
fern/products/docs/docs.yml
Outdated
| path: ./pages/integrations/postman.mdx | ||
| - page: Mintlify | ||
| path: ./pages/integrations/docs/mintlify.mdx | ||
| slug: docs/mintlify |
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.
remove slug
- Remove slug: docs/mintlify from navigation - Remove redirect from /integrations/sdks/mintlify to /integrations/docs/mintlify Co-Authored-By: danny@buildwithfern.com <danny@buildwithfern.com>
fern/products/docs/docs.yml
Outdated
| - page: Postman | ||
| path: ./pages/integrations/postman.mdx | ||
| - page: Mintlify | ||
| path: ./pages/integrations/docs/mintlify.mdx |
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.
Get rid of /docs here
|
|
||
| <Card | ||
| title="Mintlify" | ||
| href="/docs/integrations/docs/mintlify" |
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.
No /docs
- 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 <danny@buildwithfern.com>
Add Mintlify integration documentation
Summary
Added a concise documentation page explaining how to integrate Fern-generated SDKs with Mintlify documentation sites. The integration works by referencing Fern's OpenAPI spec (enriched with SDK code samples) in Mintlify's
docs.jsonconfiguration.Changes:
fern/products/docs/pages/integrations/mintlify.mdx(28 lines)Review & Testing Checklist for Human
https://registry.buildwithfern.com/{org}/{api-name}/openapi/openapi.jsonbut this infrastructure hasn't been implemented. Should this PR be merged before or after the registry is live? If merged now, users following these instructions will get 404 errors./learn/docs/integrations/mintlifyand check formatting, code blocks, and that it matches the concise style requested/learn/docs/integrations/overviewand clicking it navigates to the correct pageTest Plan
Notes
integrations/sdks/fern.mdx→ renamed tomintlify.mdxintegrations/docs/mintlify.mdx→ moved tointegrations/mintlify.mdx(no subdirectory)