Skip to content

Commit

Permalink
feat(docs): add mintlify comparison (#5197)
Browse files Browse the repository at this point in the history
feature(docs): add mintlify comparison

Co-authored-by: Chris  McDonnell <chrismcdonnell@Chriss-MacBook-Pro.local>
  • Loading branch information
cdonel707 and Chris McDonnell authored Nov 18, 2024
1 parent 105f7d5 commit d9901d4
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 1 deletion.
3 changes: 3 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,9 @@ navigation:
- page: ReadMe
slug: readme
path: ./pages/docs/comparison/readme.mdx
- page: Mintlify
slug: mintlify
path: ./pages/docs/comparison/mintlify.mdx

- tab: cli-api
layout:
Expand Down
101 changes: 101 additions & 0 deletions fern/pages/docs/comparison/mintlify.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: Mintlify
subtitle: How do Fern and Mintlify differ?
---

### 1. Documentation Design and User Experience

**Mintlify**:
- Intuitive UI editor, making it accessible for users without technical expertise.
- Limits body responses to 200, which may restrict large response formats and lacks features to tailor to your audience and API.
- Works well for SMBs with limited requirements.

**Fern**:
- Provides dynamic SDK generation and robust API documentation features.
- Designed for technical teams, with a code first approach enabling easier use of JS, CSS, and React.
- Offers collapsible response sections, reducing the need for excessive scrolling.
- Extnesive capablities enabling SMB through Enterprise customers.

---

### 2. Feature Support

| Feature | Mintlify | Fern |
|----------------------------------------------|----------|------|
| Clean Documentation UI |||
| Markdown Support |||
| Versioning Support for APIs |||
| Search Functionality in Documentation |||
| UI Editor |||
| Auto-Populate API Credentials |||
| Websockets Reference & Playground |||
| Multiple Examples per API Endpoint |||
| Dynamic SDK Examples in API Playground |||
| API Playground as Separate Component |||
| Environment Support (Staging, Production) |||
| Role-Based Access Control (RBAC) |||
| Unlimited Number of Editors |||


**Additional Features in Fern**:
- **API Playground as Separate Component**: Fern's API Playground is a distinct feature, similar to Stripe's, allowing users to interact with the API directly within the documentation.
- **Environment Support**: Supports multiple environments such as staging and production, enabling users to test APIs in different settings.
- **Role-Based Access Control (RBAC)**: Allows restriction of content based on the viewer's role, ensuring appropriate access levels.
- **Unlimited Number of Editors**: Does not limit the number of editors, facilitating collaboration among large teams.

---

### 3. Support and Community

**Mintlify**:
- Dedicated support is only available on the Enterprise tier, which may limit access for smaller teams.

**Fern**:
- Offers a dedicated Slack channel for support across all tiers, ensuring direct access to assistance for all users.

---

### 4. Security and Reliability

| Aspect | Mintlify | Fern |
|----------------|------------------|-----------------|
| Data Breaches | Yes (recent incident) | No |
| Uptime | 99.5% | 99.5% |

**Mintlify**:
- Recently experienced a significant security incident, raising concerns about data protection.

**Fern**:
- No reported data breaches, reflecting strong security protocols.

---

### 5. Customization

| Aspect | Mintlify | Fern |
|---------------------------------|----------|------|
| Custom JavaScript Files | Single | Multiple |

**Mintlify**:
- Allows only a single custom JavaScript file in the file structure, limiting extensibility.

**Fern**:
- Supports multiple custom JavaScript files, offering greater flexibility for customization.

---

### 6. Pricing

| Platform | Price (per month) |
|----------|-------------------|
| Mintlify | $350 |
| Fern | $400 |

**Mintlify**:
- Priced at $350/month.

**Fern**:
- Priced at $400/month, offering a comprehensive suite of features.


Want to improve this comparison? Use the "Edit this Page" feature at the bottom to submit a Pull Request with revisions
2 changes: 1 addition & 1 deletion fern/pages/docs/comparison/readme.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: ReadMe
excerpt: How do Fern and ReadMe differ?
subtitle: How do Fern and ReadMe differ?
---

[ReadMe](https://www.readme.com/), similar to Fern, supports generating docs for APIs. Below, we walk through the different capabilities of Fern and ReadMe.
Expand Down

0 comments on commit d9901d4

Please sign in to comment.