Skip to content
Merged
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
25 changes: 22 additions & 3 deletions changelog/2024-09.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
---
title: "September 2024"
description: "Speed improvements and JWT Auth"
description: "Custom fonts, images in cards, and more"
---

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

You can now use any Google Font or add a custom font to your docs.

## [Images in Card components](/content/components/cards#image-card)

Add an `img` property to a card to display an image on the top of the card.
## Update Speed Performances

For large projects (~3,000 files), the download step for docs updates is now
Expand All @@ -16,8 +21,22 @@ updates are now ~5.5x faster - an 81.8% time reduction.
The navbar hierarchy follows the aria hierarchy. We also added an aria label to
the light/dark mode toggle.

## Dashboard Improvements

- App router migration in the dashboard.
- Search analytics are now available in the dashboard.
- Delete an org functionality has been added to the dashboard.
- Shipped GitLab connection UI.
- Fix incorrect analytics data.
- Add-on's can now be directly purchased through the dashboard.

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

- **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)
[Read the docs](/api-playground/troubleshooting)
90 changes: 90 additions & 0 deletions changelog/2024-10.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
title: "October 2024"
description: "New landing page, advanced footer, and more"
---

<Info>Last updated on: **2024-10-23**</Info>

## [Code Line Highlighting](/content/components/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.

```javascript Line Highlighting Example {1,3-5}
const greeting = "Hello, World!";
function sayHello() {
console.log(greeting);
}
sayHello();
```

````md
```javascript Line Highlighting Example {1,3-5}
const greeting = "Hello, World!";
function sayHello() {
console.log(greeting);
}
sayHello();
```
````

## Light mode code blocks

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

```json
"code": {
"mode": "auto"
}
```

## Advanced Footer

<img src="/images/changelog/advanced-footer.gif" alt="Advanced Footer" />

You can now add more links to the standard footer. This upgrade
provides more consistency between landing pages and docs, or greater customization
if you want to spotlight specific pages like socials or status logs.

## New Landing Page

<img src="/images/changelog/landing-page.jpeg" alt="Landing Page" />

1. Showcasing vision for the future

It's been a year since we've last updated our landing page, and our team has shipped A LOT.

As we grow, we will no longer be just a documentation platform, but the platform for technical content, encompassing much more than just docs.

2. Feature our new customers

We've gotten to work with many incredible companies, and wanted to give them a shoutout.

3. Increase iteration velocity

Instead of building a standalone app, we built it in Webflow. This way, our entire team can contribute and experiment with the landing page.

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

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

- Consolidated the login and signup pages to decrease friction and confusion.
- Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.

## Bug Fixes

- Fixed `suggestEdit` not showing up even when enabled.
- Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results.
- Don't allow search engines to crawl user-auth protected pages.
- Revalidate the cache when an org is deleted.
- We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.
- Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.
- Add in-line-style support for icons
- Fixed the pop-in of custom CSS in docs.
- Properly show in-line code styling in conjunction with links.
- Maintain scroll position when you click the back button in a browser.
67 changes: 67 additions & 0 deletions changelog/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "Changelog"
---

<Update label="2024-10-23">
<img src="/images/changelog/changelog.jpg" alt="Changelog" />

We've added a changelog to the docs to make it easier to see what's changed between versions and so that you can easily create your own changelog.

[Read more →](/content/components/update)
</Update>

<Update label="2024-10-16">
## Advanced Footer

<img src="/images/changelog/advanced-footer.gif" alt="Advanced Footer" />

You can now add more links to the standard footer. This upgrade
provides more consistency between landing pages and docs, or greater customization
if you want to spotlight specific pages like socials or status logs.

[Read October updates →](/changelog/2024-10)
</Update>

<Update label="2024-09-20">
## Custom Fonts

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

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.

[Read September updates →](/changelog/2024-09)
</Update>

<Update label="2024-09-19">
<img src="/images/changelog/seo-improvements.jpeg" alt="SEO Improvements" />

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.
</Update>

<Update label="2024-09-10">
<img src="/images/changelog/performance-improvements.png" alt="Performance Improvements" />

A good developer experience involves low latency and a snappy user experience.

For majority of our customers this was the case, but as we grew we noticed that some of our customers were really pushing our product to its edges in terms of scale.

This is why we decided to devote time to making sure customers of all sizes can experience speed.

- 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.
- For API reference pages with complex data types, we have drastically reduced the size of the page. For customers with complex, recursive OpenAPI data types, this means a size reduction of up to 98%.

[Read August updates →](/changelog/2024-08)
</Update>


<Update label="2024-07-16">
## [AI Widget](https://mintlify.com/blog/widget)

<img src="/images/changelog/widget.png" alt="AI Widget" />

Documentation is just one part of the solution. The real problem is getting developers to their answers ASAP.

The Widget is an extension of your docs built to instantly answer your users' questions when and where they need it.

[Read July updates →](/changelog/2024-07)
</Update>
Binary file added images/changelog/advanced-footer.gif
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/changelog.jpg
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/custom-fonts.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/landing-page.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/performance-improvements.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/seo-improvements.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/widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@
{
"name": "Advanced",
"url": "advanced"
},
{
"name": "Changelog",
"url": "changelog"
}
],
"navigation": [
Expand Down Expand Up @@ -219,6 +223,27 @@
"content/components/expandables",
"content/components/sticky-examples"
]
},
{
"group": "",
"pages": ["changelog/overview"]
},
{
"group": "Product Updates",
"pages": [
"changelog/2024-10",
"changelog/2024-09",
"changelog/2024-08",
"changelog/2024-07"
]
},
{
"group": "Launch Weeks",
"pages": [
"changelog/lw/3",
"changelog/lw/2",
"changelog/lw/1"
]
}
],
"footer": {
Expand Down
11 changes: 9 additions & 2 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ description: "Start building modern documentation in under five minutes"
icon: "rocket"
---

```json hello world {2}
{
"hello": "world",
"foo": "bar"
}
```

<Frame>
<img
className="block dark:hidden"
Expand All @@ -23,8 +30,8 @@ supercharge your documentation with Mintlify.
### 1. Deploying Your Docs Repository

Mintlify docs are rendered from MDX files and configurations defined in our
[starter kit](https://github.com/mintlify/starter). We use Github to
integrate your docs with your code, and make source control effortless.
[starter kit](https://github.com/mintlify/starter). We use Github to integrate
your docs with your code, and make source control effortless.

<AccordionGroup>
<Accordion icon="github" title="Creating Your Documentation Repository">
Expand Down