Skip to content
Closed
Show file tree
Hide file tree
Changes from all 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
8 changes: 5 additions & 3 deletions advanced/rest-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ title: Introduction
The Mintlify REST API is only available on the startup plan and above.
</Check>

Leverage the external API to programmatically trigger an update when desired.
🚀 Leverage the external API to programmatically trigger an update when desired.
The primary use-case will be to trigger updates. We will be adding more and more
functionality to the API overtime. Let us know what else you want to see in
functionality to the API overtime. 💡 Let us know what else you want to see in
[our community](https://mintlify.com/community)!

## Authentication
## Authentication 🔐

You can generate an API key through
[the dashboard](https://dashboard.mintlify.com/settings/integrations). The API key is
Expand All @@ -20,3 +20,5 @@ associated with the entire org and can be used across multiple deployments.
<Frame>
<img src="/images/external-api-key.png" />
</Frame>
</fileContent>
</invoke>
8 changes: 4 additions & 4 deletions api-playground/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: 'Interactive Playground'
title: '🎮 Interactive Playground'
description: 'Enable users to interact with your API'
openapi: 'GET /plants/{id}'
hideApiMarker: true
icon: 'play'
---

The API playground is an interactive environment to make requests and preview an API endpoint.
The API playground is an interactive environment to make requests and preview an API endpoint. 🚀

<Info>
Autogenerating API pages with OpenAPI will automatically generate API
Autogenerating API pages with OpenAPI will automatically generate API
playground. Read more about using OpenAPI with Mintlify
[here](/api-playground/openapi).
</Info>
</Info>
60 changes: 30 additions & 30 deletions changelog/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ mode: "wide"
---

<Update label="November 2024">
## AI Assistant
## 🤖 AI Assistant

<Frame>
<img src="/images/changelog/ai-assistant.jpg" alt="AI Assistant" />
</Frame>

You can now ask AI to make changes to your docs, with the context of all existing documentation. Type in a prompt and the assistant will propose changes by generating a pull request.

## GitLab Integration Upgrade
## 🔄 GitLab Integration Upgrade

We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/settings/gitlab) to get started.

## Web Editor
## ✍️ Web Editor

<Frame>
<img src="/images/changelog/webeditor.jpg" alt="Web Editor" />
Expand All @@ -27,35 +27,35 @@ mode: "wide"

Check out our [docs on getting started with Web Editor](/web-editor).

## /llms.txt support
## 🧠 /llms.txt support

<Frame>
<img src="/images/changelog/llms.jpg" alt="llms.txt support" />
</Frame>

All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

## Localization
## 🌍 Localization

You can now localize your docs which operates similarly to versioning. Add a `locale` to a version and fixed content in Mintlify like "Was this page helpful?" will also match the locale.

### Quality Improvements
### ⭐️ Quality Improvements

* Return chat & search results based on the current version that the user is reading

* Authenticate users with OAuth, in addition to JWT or Shared Session tokens.
</Update>

<Update label="October 2024">
## Changelogs
## 📝 Changelogs

Launched a new [Update component](/content/components/update) to make it easier to display and report updates (like this one) to your users.

<Frame>
<img src="/images/changelog/changelog.jpg" alt="Changelog" />
</Frame>

## Code Line Highlighting
## Code Line Highlighting

You can now highlight lines of code in your docs to emphasize and bring attention to important parts by adding a special comment after the language identifier. Use curly braces `{}` and specify line numbers or ranges separated by commas.

Expand All @@ -77,7 +77,7 @@ mode: "wide"
```
````

## Light mode code blocks
## 💡 Light mode code blocks

Code blocks now have a light mode variant which can be enabled by adding the following to your `mint.json`:

Expand All @@ -87,7 +87,7 @@ mode: "wide"
}
```

## Advanced Footer
## 🎨 Advanced Footer

<Frame>
<img src="/images/changelog/advanced-footer.gif" alt="Advanced Footer" />
Expand All @@ -97,15 +97,15 @@ mode: "wide"
provides more consistency between landing pages and docs, or greater customization
if you want to spotlight specific pages like socials or status logs.

## Filter search based on the current user
## 🔍 Filter search based on the current user

When user auth is enabled, search results are now filtered based on the current logged in user so that they only see the relevant content.

## Custom Prompts for AI Chat
## 💬 Custom Prompts for AI Chat

You can now customize the prompts for the AI chat. Please reach out to [support](mailto:[email protected]) if you'd like to customize the prompts.

## Dashboard Improvements
## 📊 Dashboard Improvements

* Added ability to change custom domain to be /docs directly through dashboard settings.

Expand All @@ -117,7 +117,7 @@ mode: "wide"

* Added ability to add new deployment through dashboard settings.

## Bug Fixes
## 🐛 Bug Fixes

* Can now use leading slashes in navigation.

Expand Down Expand Up @@ -145,19 +145,19 @@ mode: "wide"
</Update>

<Update label="September 2024">
## Custom Fonts
## 🎯 Custom Fonts

<Frame>
<img src="/images/changelog/custom-fonts.jpeg" alt="Custom Fonts" />
</Frame>

Personalize the font of your docs to your own font hosted on a CDN or by choosing from Google fonts to match your docs with your brand.

## Images in Card components
## 🖼️ Images in Card components

Add an `img` property to a card to display an image on the top of the card. Learn more about it [here](/content/components/cards#image-card).

## Update Speed Performances
## ⚡️ Update Speed Performances

<Frame>
<img src="/images/changelog/performance-improvements.png" alt="Performance Improvements" />
Expand All @@ -167,15 +167,15 @@ mode: "wide"
\~440x faster - a 99.8% time reduction. Across the board, file downloads during
updates are now \~5.5x faster - an 81.8% time reduction.

## SEO improvements
## 🔎 SEO improvements

<Frame>
<img src="/images/changelog/seo-improvements.jpeg" alt="SEO Improvements" />
</Frame>

We've fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements.

## Dashboard Improvements
## 📱 Dashboard Improvements

* App router migration in the dashboard.

Expand All @@ -189,21 +189,21 @@ mode: "wide"

* Add-on's can now be directly purchased through the dashboard.

## Bug Fixes
## 🔧 Bug Fixes

* Fixed a bug where the top bar would not stretch to the width of the screen when it's in custom mode and the sidebar layout is `sidenav`.

* Fix relative positioning of the AI widget.

## More
## More

* **Troubleshooting for API pages**: API pages could be complicated so we listed
common issues to help you sort them out quickly —
[Read the docs](/api-playground/troubleshooting)
</Update>

<Update label="August 2024">
## OpenAPI Reference Pages
## 📚 OpenAPI Reference Pages

* Endpoints defined by OpenAPI that are complex and recursive are now 98%
smaller.
Expand All @@ -212,25 +212,25 @@ mode: "wide"
[additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/)
in OpenAPI pages.

## File Uploads in API Playground
## 📤 File Uploads in API Playground

By default, API playground requests are proxied by Mintlify. Now you can use
`disableProxy` to disable this behavior and support request types like file
uploads.

* [Learn more about API configurations](/settings/global#api-configurations)

## Mobile SEO improvements
## 📱 Mobile SEO improvements

We've fixed the mobile layout of our docs so that they are more SEO-friendly -
including adding proper aria tags to elements.

## Support Form
## 💌 Support Form

We added a more detailed support form to the Mintlify dashboard. You can now
submit a form to get in touch with us.

## Bug Fixes
## 🐛 Bug Fixes

* Fixed a bug for the Segment integration functionality.

Expand All @@ -242,7 +242,7 @@ mode: "wide"
</Update>

<Update label="July 2024">
## AI Widget
## 🤖 AI Widget

<Frame>
<img src="/images/changelog/widget.png" alt="AI Widget" />
Expand All @@ -257,17 +257,17 @@ mode: "wide"

* [Learn how to install the Widget](/advanced/widget/chat#getting-started)

## Pro Plan
## ⭐️ Pro Plan

We also updated our pricing plans for better customizability and scale.

* [Read the blog announcement](https://mintlify.com/blog/pro-plan)

## API Playground Code Example Sync
## 🔄 API Playground Code Example Sync

When you browse API docs, the selected code example now syncs across your pages.

## Insights
## 📊 Insights

Currently in beta, this feature summarizes common user questions and patterns
into easy-to-digest reports with AI-powered suggestions on how to improve your
Expand Down
28 changes: 15 additions & 13 deletions content/components/update.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Update"
description: "Keep track of changes and updates"
title: "Update 📝"
description: "Keep track of changes and updates ⏱️"
icon: "rectangle-history"
---

The `Update` component is used to keep track of changes and updates.
The `Update` component is used to keep track of changes and updates 📊

<Update label="2024-10-12" description="v0.1.1">
<Frame>
Expand All @@ -14,17 +14,17 @@ The `Update` component is used to keep track of changes and updates.
/>
</Frame>

## Changelog
## Changelog 📋

You can add anything here, like a screenshot, a code snippet, or a list of changes.

#### Features
- Responsive design
- Sticky section for each changelog
#### Features
- Responsive design 📱
- Sticky section for each changelog 📌
</Update>

<Update label="2024-10-11" description="v0.1.0">
### How to use
### How to use 🛠️
```md
<Update label="2024-10-12" description="v0.1.1">
This is how you use a changelog with a label
Expand All @@ -36,19 +36,21 @@ The `Update` component is used to keep track of changes and updates.
</Update>
```

You can use multiple `Update` components to create changelogs.
You can use multiple `Update` components to create changelogs
</Update>

<Tip>
Each `label` creates an anchor and also shows up on the table of contents on the right.
💡 Each `label` creates an anchor and also shows up on the table of contents on the right.
</Tip>

## Props
## Props 🔧

<ResponseField name="label" type="string" required>
Label in the changelog, on the sticky left side.
Label in the changelog, on the sticky left side 📍
</ResponseField>

<ResponseField name="description" type="string">
Description below the label in the Changelog preview.
Description below the label in the Changelog preview 📝
</ResponseField>
</fileContent>
</invoke>
12 changes: 7 additions & 5 deletions integrations/privacy/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Privacy Integrations"
description: "Integrate with a data privacy platform"
title: "Privacy Integrations 🔐"
description: "Integrate with a data privacy platform 🛡️"
---

<CardGroup>
Expand All @@ -13,14 +13,16 @@ description: "Integrate with a data privacy platform"
</Card>
</CardGroup>

## Enabling Data Privacy Integrations
## Enabling Data Privacy Integrations 🔒

You can add data privacy platforms onto your docs. Add the `integrations` field into your `mint.json` file with your respective scripts.
You can add data privacy platforms onto your docs. Add the `integrations` field into your `mint.json` file with your respective scripts.

```json
"integrations": {
"osano": "SOURCE"
}
```

If you'd like to request a data privacy platform integration, please let us know in [our community](https://mintlify.com/community).
If you'd like to request a data privacy platform integration, please let us know in [our community](https://mintlify.com/community) 💬
</newContent>
</invoke>
Loading
Loading