Skip to content

Commit f646c95

Browse files
authored
Add changelog (#311)
* add changelog * add more fixes
1 parent c2d894e commit f646c95

File tree

12 files changed

+213
-5
lines changed

12 files changed

+213
-5
lines changed

changelog/2024-09.mdx

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
---
22
title: "September 2024"
3-
description: "Speed improvements and JWT Auth"
3+
description: "Custom fonts, images in cards, and more"
44
---
55

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

8+
You can now use any Google Font or add a custom font to your docs.
9+
10+
## [Images in Card components](/content/components/cards#image-card)
11+
12+
Add an `img` property to a card to display an image on the top of the card.
813
## Update Speed Performances
914

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

24+
## Dashboard Improvements
25+
26+
- App router migration in the dashboard.
27+
- Search analytics are now available in the dashboard.
28+
- Delete an org functionality has been added to the dashboard.
29+
- Shipped GitLab connection UI.
30+
- Fix incorrect analytics data.
31+
- Add-on's can now be directly purchased through the dashboard.
32+
33+
## Bug Fixes
34+
35+
- 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`.
36+
- Fix relative positioning of the AI widget.
37+
1938
## More
2039

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

changelog/2024-10.mdx

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
title: "October 2024"
3+
description: "New landing page, advanced footer, and more"
4+
---
5+
6+
<Info>Last updated on: **2024-10-23**</Info>
7+
8+
## [Code Line Highlighting](/content/components/code#line-highlighting)
9+
10+
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.
11+
12+
```javascript Line Highlighting Example {1,3-5}
13+
const greeting = "Hello, World!";
14+
function sayHello() {
15+
console.log(greeting);
16+
}
17+
sayHello();
18+
```
19+
20+
````md
21+
```javascript Line Highlighting Example {1,3-5}
22+
const greeting = "Hello, World!";
23+
function sayHello() {
24+
console.log(greeting);
25+
}
26+
sayHello();
27+
```
28+
````
29+
30+
## Light mode code blocks
31+
32+
Code blocks now have a light mode variant which can be enabled by adding the following to your `mint.json`:
33+
34+
```json
35+
"code": {
36+
"mode": "auto"
37+
}
38+
```
39+
40+
## Advanced Footer
41+
42+
<img src="/images/changelog/advanced-footer.gif" alt="Advanced Footer" />
43+
44+
You can now add more links to the standard footer. This upgrade
45+
provides more consistency between landing pages and docs, or greater customization
46+
if you want to spotlight specific pages like socials or status logs.
47+
48+
## New Landing Page
49+
50+
<img src="/images/changelog/landing-page.jpeg" alt="Landing Page" />
51+
52+
1. Showcasing vision for the future
53+
54+
It's been a year since we've last updated our landing page, and our team has shipped A LOT.
55+
56+
As we grow, we will no longer be just a documentation platform, but the platform for technical content, encompassing much more than just docs.
57+
58+
2. Feature our new customers
59+
60+
We've gotten to work with many incredible companies, and wanted to give them a shoutout.
61+
62+
3. Increase iteration velocity
63+
64+
Instead of building a standalone app, we built it in Webflow. This way, our entire team can contribute and experiment with the landing page.
65+
66+
## Filter search based on the current user
67+
68+
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.
69+
70+
## Custom Prompts for AI Chat
71+
72+
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.
73+
74+
## Dashboard Improvements
75+
76+
- Consolidated the login and signup pages to decrease friction and confusion.
77+
- Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.
78+
79+
## Bug Fixes
80+
81+
- Fixed `suggestEdit` not showing up even when enabled.
82+
- Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results.
83+
- Don't allow search engines to crawl user-auth protected pages.
84+
- Revalidate the cache when an org is deleted.
85+
- We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.
86+
- Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.
87+
- Add in-line-style support for icons
88+
- Fixed the pop-in of custom CSS in docs.
89+
- Properly show in-line code styling in conjunction with links.
90+
- Maintain scroll position when you click the back button in a browser.

changelog/overview.mdx

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: "Changelog"
3+
---
4+
5+
<Update label="2024-10-23">
6+
<img src="/images/changelog/changelog.jpg" alt="Changelog" />
7+
8+
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.
9+
10+
[Read more →](/content/components/update)
11+
</Update>
12+
13+
<Update label="2024-10-16">
14+
## Advanced Footer
15+
16+
<img src="/images/changelog/advanced-footer.gif" alt="Advanced Footer" />
17+
18+
You can now add more links to the standard footer. This upgrade
19+
provides more consistency between landing pages and docs, or greater customization
20+
if you want to spotlight specific pages like socials or status logs.
21+
22+
[Read October updates →](/changelog/2024-10)
23+
</Update>
24+
25+
<Update label="2024-09-20">
26+
## Custom Fonts
27+
28+
<img src="/images/changelog/custom-fonts.jpeg" alt="Custom Fonts" />
29+
30+
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.
31+
32+
[Read September updates →](/changelog/2024-09)
33+
</Update>
34+
35+
<Update label="2024-09-19">
36+
<img src="/images/changelog/seo-improvements.jpeg" alt="SEO Improvements" />
37+
38+
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.
39+
</Update>
40+
41+
<Update label="2024-09-10">
42+
<img src="/images/changelog/performance-improvements.png" alt="Performance Improvements" />
43+
44+
A good developer experience involves low latency and a snappy user experience.
45+
46+
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.
47+
48+
This is why we decided to devote time to making sure customers of all sizes can experience speed.
49+
50+
- 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.
51+
- 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%.
52+
53+
[Read August updates →](/changelog/2024-08)
54+
</Update>
55+
56+
57+
<Update label="2024-07-16">
58+
## [AI Widget](https://mintlify.com/blog/widget)
59+
60+
<img src="/images/changelog/widget.png" alt="AI Widget" />
61+
62+
Documentation is just one part of the solution. The real problem is getting developers to their answers ASAP.
63+
64+
The Widget is an extension of your docs built to instantly answer your users' questions when and where they need it.
65+
66+
[Read July updates →](/changelog/2024-07)
67+
</Update>
1.01 MB
Loading

images/changelog/changelog.jpg

4.4 MB
Loading

images/changelog/custom-fonts.jpeg

168 KB
Loading

images/changelog/landing-page.jpeg

37.5 KB
Loading
2.6 MB
Loading
171 KB
Loading

images/changelog/widget.png

3.8 MB
Loading

0 commit comments

Comments
 (0)