Skip to content
Merged
30 changes: 30 additions & 0 deletions changelog/2024-07.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "July 2024"
description: "Introducing the Mintlify Widget and the Pro plan"
---

## Mintlify Widget

For `Pro` users, we introduced Mintlify Widget, an extension of your docs to
answer your users' questions when and where they asked. You can add this
AI-powered chatbot to any web page: your landing page, inside your product, or
on your existing documentation pages.

- [Read the blog announcement](https://mintlify.com/blog/widget)
- [Learn how to install the Widget](/advanced/widget/chat#getting-started)

## 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

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

## 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
product.
38 changes: 38 additions & 0 deletions changelog/2024-08.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "August 2024"
description: "Web Editor UI, API Playground Update, and AI Chat"
---

## OpenAPI Reference Pages

- Endpoints defined by OpenAPI that are complex and recursive are now 98%
smaller.
- We now show
[additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/)
in OpenAPI pages.

## 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

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

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

- Fixed a bug for the Segment integration functionality.
- We now raise more granular error messages for GitHub permissions when
interacting with the editor.
- Fixed bugs where the navigation would not properly expand when a direct link
was used.
23 changes: 23 additions & 0 deletions changelog/2024-09.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "September 2024"
description: "Speed improvements and JWT Auth"
---

<Info>Last updated on: **2024-09-15**</Info>

## Update Speed Performances

For large projects (~3,000 files), the download step for docs updates is now
~440x faster - a 99.8% time reduction. Across the board, file downloads during
updates are now ~5.5x faster - an 81.8% time reduction.

## Desktop SEO improvements

The navbar hierarchy follows the aria hierarchy. We also added an aria label to
the light/dark mode toggle.

## 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)
41 changes: 41 additions & 0 deletions changelog/lw/1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: 'Launch Week I'
description: 'CLI Enhancements, Docs Feedback, Global CSS, API Playground Redesign, Web Editor'
---

<Frame>
<img src="/images/changelog/launch-week-1.png" />
</Frame>

## CLI Enhancements

We shipped a prebuilt and compiled version of Mintlify that's ready to run in seconds. Plus, we added a custom hot-reloading implementation to speed up development.

- [Read the blog announcement](https://mintlify.com/blog/launch-week-day-1)

## Docs Feedback

This feature allows users to upvote or downvote on the helpfulness of a documentation page. You can identify which pages are underperforming and where to focus efforts.

- [Read the blog announcement](https://mintlify.com/blog/launch-week-day-2)

## Global CSS

If you're searching for the design functions needed to seamlessly fit your docs into your brand, look no further. Now, you can alter design, layout, and variations for different device displays, all from a single style sheet.

- [Read the blog announcement](https://mintlify.com/blog/launch-week-day-3)
- [Learn more about Custom CSS](/advanced/custom/css)

## API Playground Redesign

We overhauled the API Playground for a new and improved design. This upgrade handles edge cases and offers expanded features, including technical functions, effortless UX, and sleek UI.

- [Read the blog announcement](https://mintlify.com/blog/launch-week-day-4)
- [Learn more about the API Playground](/api-playground/overview)

## Web Editor

Built with markdown parsers and inspired by code editors like VS Code, the Web Editor lets you alter docs content on the web, commit and push in-editor, access a high-fidelity preview of your docs content next to code — without CLI, and preview valid markdown edits.

- [Read the blog announcement](https://mintlify.com/blog/launch-week-day-5)
- [Go to the editor](https://dashboard.mintlify.com/editor)
41 changes: 41 additions & 0 deletions changelog/lw/2.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: 'Launch Week II'
description: 'Preview Deployments, Snippets V2, Open-source MDX Engine, Custom JS, Chat Analytics'
---

<Frame>
<img src="/images/changelog/launch-week-2.jpeg" />
</Frame>

## Preview Deployments

Now, when a user creates a pull request, we will generate a unique link that shows exactly what your docs will look like in production before they are live.

- [Read the blog announcement](https://mintlify.com/blog/launch-week-2-day-1)

## Snippets V2

Snippets V2 offers more flexibility and performance while being rebuilt from the ground up to resemble the import experience that developers know and love.

- [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-2)
- [Learn more about Reusable Snippets](/reusable-snippets)

## Open Source MDX Engine

You can now integrate our package to access Mintlify-flavored markdown and code syntax highlighting.

- [Read the blog announcement](https://mintlify.com/blog/launch-week-2-day-3)
- [Star this repo on GitHub](https://github.com/mintlify/mdx)

## Custom JS

Custom JS allows you to add custom executable code globally. It's the equivalent of adding a `<script>` tag with JS code into every page.

- [Read the blog announcement](https://mintlify.com/blog/launch-week-2-day-4)
- [See example here](/advanced/custom/js#adding-script-js)

## Chat Analytics

AI Chat Analytics takes a step forward by providing more detail on what your users as asking as well as how the chatbot responds. Now, you can segment chat history by date, manage your AI Chat usage, and find information about how often a specific query appears.

- [Read the blog announcement](https://mintlify.com/blog/launch-week-2-day-5)
46 changes: 46 additions & 0 deletions changelog/lw/3.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: 'Launch Week III'
description: 'Themes, Search V2, Branching, User Auth, OpenAPI Automations'
---

<Frame>
<img src="/images/changelog/launch-week-3.png" />
</Frame>

## Themes

Themes enables you to transform the styling and layout of your documentation to fit your branding. We've unveiled three themes: **[Quill](https://starter-quill.mintlify.app/), [Prism](https://starter-prism.mintlify.app/), and [Venus](https://starter-venus.mintlify.app/).**

To try out any themes for yourself, just add the following line into your `mint.json` file with any of the following values:

```
"theme": "quill" | "prism" | "venus"
```

- [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-1)
- [View source code on GitHub](https://github.com/mintlify/themes)

## Search V2

Upgraded UI, indexing OpenAPI endpoints, removing hidden pages from search, indexing support for components.

- [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-2)

## Web Editor Branching

The Web Editor allows users to alter your docs content right on the web without an IDE. Branches allow you to create separate versions of your documentation without affecting the main project — they're like parallel universes for code.

- [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-3)

## User Auth

When writing documentation, you may want to limit which user guides are shown to your customers. With User Auth, identify your users and tailor your docs content to them.

- [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-4)
- [Learn more about User Auth](/advanced/user-auth)

## OpenAPI Automations

When you're constantly shipping changes to your API, it's important to reflect those changes in your documentation as soon as possible. Our revamped setup makes autogenerating your API Reference docs seamless, removing the need for any manual labor to reflect changes in production.

- [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-5)
Binary file added images/changelog/launch-week-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/changelog/launch-week-2.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/changelog/launch-week-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 25 additions & 16 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@
{
"name": "Advanced",
"url": "advanced"
},
{
"name": "Changelog",
"url": "changelog"
}
],
"navigation": [
Expand Down Expand Up @@ -132,10 +136,7 @@
},
{
"group": "SDKs",
"pages": [
"integrations/sdks/speakeasy",
"integrations/sdks/stainless"
]
"pages": ["integrations/sdks/speakeasy", "integrations/sdks/stainless"]
},
{
"group": "Support",
Expand All @@ -147,17 +148,11 @@
},
{
"group": "Privacy",
"pages": [
"integrations/privacy/overview",
"integrations/privacy/osano"
]
"pages": ["integrations/privacy/overview", "integrations/privacy/osano"]
},
{
"group": "Custom Scripts",
"pages": [
"advanced/custom/css",
"advanced/custom/js"
]
"pages": ["advanced/custom/css", "advanced/custom/js"]
},
{
"group": "Custom Subpaths",
Expand All @@ -168,9 +163,7 @@
},
{
"group": "Extensions",
"pages": [
"advanced/widget/chat"
]
"pages": ["advanced/widget/chat"]
},
{
"group": "REST API",
Expand Down Expand Up @@ -221,6 +214,22 @@
"content/components/expandables",
"content/components/sticky-examples"
]
},
{
"group": "Product Updates",
"pages": [
"changelog/2024-09",
"changelog/2024-08",
"changelog/2024-07"
]
},
{
"group": "Launch Weeks",
"pages": [
"changelog/lw/3",
"changelog/lw/2",
"changelog/lw/1"
]
}
],
"footerSocials": {
Expand All @@ -236,4 +245,4 @@
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
}
}
}
}