Skip to content

Commit 08236bc

Browse files
Documentation edits made through Mintlify web editor
1 parent 38d1f02 commit 08236bc

File tree

1 file changed

+84
-61
lines changed

1 file changed

+84
-61
lines changed

changelog/overview.mdx

Lines changed: 84 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -4,58 +4,72 @@ description: "New updates and improvements"
44
mode: "center"
55
---
66

7-
<Update label = "February 2025">
7+
<Update label="February 2025">
8+
## .md support for LLMs
89

9-
## docs.json replacing mint.json
10-
Upgrades include better multi-level versioning, easier visual comprehension, and more consistent terminology.
10+
All documentation pages are now automatically available as plain Markdown files—just append `.md` to the URL. This makes it easier for LLMs to ingest individual pages from your documentation.
1111

12-
[Update your Mintlify CLI](/navigation/config-upgrade#upgrading-from-mint-json-to-docs-json).
12+
## docs.json replacing mint.json
1313

14-
## CI Checks
15-
Automatically lint your docs to find broken links, discover spelling and grammar issues, or enforce writing styles with your own Vale config. Learn more in our [docs](settings/ci).
14+
Upgrades include better multi-level versioning, easier visual comprehension, and more consistent terminology.
1615

17-
## More Themes
18-
New pre-built themes to modify the look & feel of your docs. Configure via your [docs.json file](/settings/global).
16+
[Update your Mintlify CLI](/navigation/config-upgrade#upgrading-from-mint-json-to-docs-json).
1917

20-
Now available:
21-
- Maple
22-
- Palm
18+
## CI Checks
2319

20+
Automatically lint your docs to find broken links, discover spelling and grammar issues, or enforce writing styles with your own Vale config. Learn more in our [docs](settings/ci).
21+
22+
## More Themes
23+
24+
New pre-built themes to modify the look & feel of your docs. Configure via your [docs.json file](/settings/global).
25+
26+
Now available:
27+
28+
* Maple
29+
30+
* Palm
2431
</Update>
2532

26-
<Update label = "January 2025">
33+
<Update label="January 2025">
34+
## AI Assistant Improvements
35+
36+
* New UI with dedicated chat page & pre-filled prompts
37+
38+
* Stability improvements, e.g. bug fixes of editing the wrong file or no files at all
2739

28-
## AI Assistant Improvements
29-
- New UI with dedicated chat page & pre-filled prompts
30-
- Stability improvements, e.g. bug fixes of editing the wrong file or no files at all
31-
- More robust knowledge for adding & editing components
32-
- Improved mint.json file editing
40+
* More robust knowledge for adding & editing components
3341

34-
## Partial Authentication
35-
Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system.
42+
* Improved mint.json file editing
3643

37-
## Revamped API Playground
38-
We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include:
44+
## Partial Authentication
3945

40-
- Easier detail expansion for an overview of a field
41-
- More intuitive nested design, e.g. adding or deleting items
42-
- Faster response times
46+
Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system.
4347

44-
## Quality Improvements
45-
- Support for requiring authentication to access preview deployments
48+
## Revamped API Playground
4649

50+
We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include:
51+
52+
* Easier detail expansion for an overview of a field
53+
54+
* More intuitive nested design, e.g. adding or deleting items
55+
56+
* Faster response times
57+
58+
## Quality Improvements
59+
60+
* Support for requiring authentication to access preview deployments
4761
</Update>
4862

4963
<Update label="December 2024">
5064
## Authentication
51-
<Frame>
65+
66+
<Frame>
5267
<img src="/images/changelog/authentication.png" alt="Authentication screenshot" />
53-
</Frame>
54-
Make docs private by setting up authentication via JWT, OAuth, or a universal password. With this privacy, you can create an internal knowledge base or prevent competitors from seeing your docs.
68+
</Frame>
5569

70+
Make docs private by setting up authentication via JWT, OAuth, or a universal password. With this privacy, you can create an internal knowledge base or prevent competitors from seeing your docs.
5671
</Update>
5772

58-
5973
<Update label="November 2024">
6074
## AI Assistant
6175

@@ -327,61 +341,70 @@ We’ve overhauled the design and performance of the [API Playground](/api-playg
327341
</Update>
328342

329343
<Update label="June 2024">
344+
## Launch Week Highlights
345+
346+
* Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your `mint.json` file and it'll update your docs styling.
347+
348+
* Search V2: directly query OpenAPI endpoint descriptions and titles to reach API Reference pages, remove hidden pages from search, and enjoy our updated searchbar UI.
330349

331-
## Launch Week Highlights
332-
* Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your `mint.json` file and it'll update your docs styling.
333-
* Search V2: directly query OpenAPI endpoint descriptions and titles to reach API Reference pages, remove hidden pages from search, and enjoy our updated searchbar UI.
334-
* Web Editor branching: create branches in our web editor without an IDE.
335-
* User Personalization: authenticate users with Shared Session or JWT so that you can show them customized content, such as pre-filling API keys or showing specific content for customers.
336-
* OepenAPI Automation Upgrades: to auto-populate API Playground pages, you can add an `openapi` field to an object in tabs or anchors arrays in the mint.json.
350+
* Web Editor branching: create branches in our web editor without an IDE.
337351

352+
* User Personalization: authenticate users with Shared Session or JWT so that you can show them customized content, such as pre-filling API keys or showing specific content for customers.
353+
354+
* OepenAPI Automation Upgrades: to auto-populate API Playground pages, you can add an `openapi` field to an object in tabs or anchors arrays in the mint.json.
338355
</Update>
339356

340357
<Update label="May 2024">
358+
## Okta SSO
341359

342-
## Okta SSO
343-
We now support sign-on via Okta SAML and OIDC.
360+
We now support sign-on via Okta SAML and OIDC.
344361

345-
## Mintlify REST API
346-
Programmatically rigger updates to your documentation.
362+
## Mintlify REST API
347363

364+
Programmatically rigger updates to your documentation.
348365
</Update>
349366

350367
<Update label="April 2024">
368+
## Custom mode
351369

352-
## Custom mode
353-
Add a configuration to the metadata to remove all elements except for the top bar.
354-
Example use cases:
355-
* Create a custom global landing page setup with custom components
356-
* Add full-screen videos or image galleries
357-
* Embed custom iFrame demo elements to add intractability to your docs
370+
Add a configuration to the metadata to remove all elements except for the top bar.
371+
Example use cases:
358372

359-
Check out our [Custom Mode docs](/page#custom-mode).
360-
</Update>
373+
* Create a custom global landing page setup with custom components
374+
375+
* Add full-screen videos or image galleries
361376

377+
* Embed custom iFrame demo elements to add intractability to your docs
378+
379+
Check out our [Custom Mode docs](/page#custom-mode).
380+
</Update>
362381

363382
<Update label="March 2024">
364-
## Mintlify MDX for VSCode
365-
Call snippets of our pre-built components an dcallouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).
383+
## Mintlify MDX for VSCode
366384

385+
Call snippets of our pre-built components an dcallouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).
367386
</Update>
368387

369388
<Update label="February 2024">
389+
## Quality Improvements
390+
391+
* Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments
392+
393+
* Versioning with tabs fully supported
370394

371-
## Quality Improvements
372-
* Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments
373-
* Versioning with tabs fully supported
374-
* Wildcard redirects now supported
375-
* CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development
395+
* Wildcard redirects now supported
376396

397+
* CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development
377398
</Update>
378399

379400
<Update label="January 2024">
401+
## Launch Week Highlights
380402

381-
## Launch Week Highlights
382-
* Preview Deployments: When you create a pull request, we'll generate a unique link that shows a live preview of what your docs look like in prod. You can share this link with teammates.
383-
* Snippets V2: We now support fully reusable components and variables for snippets.
384-
* Open-source MDX Engine: We've exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. [Contributions to the project](https://github.com/mintlify/mdx) are welcome.
385-
* AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
403+
* Preview Deployments: When you create a pull request, we'll generate a unique link that shows a live preview of what your docs look like in prod. You can share this link with teammates.
386404

387-
</Update>
405+
* Snippets V2: We now support fully reusable components and variables for snippets.
406+
407+
* Open-source MDX Engine: We've exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. [Contributions to the project](https://github.com/mintlify/mdx) are welcome.
408+
409+
* AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
410+
</Update>

0 commit comments

Comments
 (0)