diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 612e034d7..8ea082112 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -5,12 +5,10 @@ mode: "center" --- - ## New Configuration Schema `docs.json` + ## New configuration schema `docs.json` We've introduced a new `docs.json` schema as a replacement for `mint.json`, to support better multi-level versioning, easier visual comprehension, and more consistent terminology. For more information on what's changed, [check out our blog](https://mintlify.com/blog/refactoring-mint-json-into-docs-json). - - Upgrade from `mint.json` to `docs.json` with the following steps: 1. Make sure your CLI is the latest version @@ -27,15 +25,15 @@ mode: "center" 3. Delete your old mint.json file and push your changes - ## CI Checks + ## CI checks 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). ## .md support for LLMs - 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. + 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. - ## More Themes + ## More themes New pre-built themes to modify the look & feel of your docs. Configure via your [docs.json file](/settings/global). @@ -47,7 +45,7 @@ mode: "center" - ## AI Assistant Improvements + ## AI assistant improvements * New UI with dedicated chat page & pre-filled prompts @@ -57,13 +55,13 @@ mode: "center" * Improved mint.json file editing - ## Partial Authentication + ## Partial authentication Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system. ## Revamped API Playground - We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include: + We've overhauled the design and performance of the [API Playground](/api-playground/). Updates include: * Easier detail expansion for an overview of a field @@ -71,7 +69,7 @@ mode: "center" * Faster response times - ## Quality Improvements + ## Quality improvements * Support for requiring authentication to access preview deployments @@ -95,7 +93,7 @@ mode: "center" 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. @@ -105,7 +103,7 @@ mode: "center" Web Editor - We've revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown. + We've revamped our Web Editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown. Check out our [docs on getting started with Web Editor](/web-editor). @@ -121,7 +119,7 @@ mode: "center" 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 @@ -137,7 +135,7 @@ mode: "center" Changelog - ## 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. @@ -169,7 +167,7 @@ mode: "center" } ``` - ## Advanced Footer + ## Advanced footer Advanced Footer @@ -183,11 +181,11 @@ mode: "center" When personalization 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:sales@mintlify.com) 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. @@ -199,7 +197,7 @@ mode: "center" * Added ability to add new deployment through dashboard settings. - ## Bug Fixes + ## Bug fixes * Can now use leading slashes in navigation. @@ -227,7 +225,7 @@ mode: "center" - ## Custom Fonts + ## Custom fonts Custom Fonts @@ -239,7 +237,7 @@ mode: "center" 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 Performance Improvements @@ -257,7 +255,7 @@ mode: "center" 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. @@ -271,7 +269,7 @@ mode: "center" * 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`. @@ -285,7 +283,7 @@ mode: "center" - ## OpenAPI Reference Pages + ## OpenAPI reference pages * Endpoints defined by OpenAPI that are complex and recursive are now 98% smaller. @@ -294,7 +292,7 @@ mode: "center" [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 @@ -307,12 +305,12 @@ mode: "center" 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. @@ -337,13 +335,13 @@ mode: "center" * [Read the blog announcement](https://mintlify.com/blog/widget) - ## 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. @@ -355,7 +353,7 @@ mode: "center" - ## Launch Week Highlights + ## Launch week highlights * 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. @@ -363,9 +361,9 @@ mode: "center" * Web Editor branching: create branches in our web editor without an IDE. - * 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. + * 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. - * 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. + * OpenAPI 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. @@ -400,7 +398,7 @@ mode: "center" - ## Quality Improvements + ## Quality improvements * Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments @@ -412,13 +410,13 @@ mode: "center" - ## Launch Week Highlights + ## Launch week highlights - * 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. + * 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. * Snippets V2: We now support fully reusable components and variables for snippets. * 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. - * AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears. - + * AI Chat insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears. + \ No newline at end of file diff --git a/docs.json b/docs.json index 381cdcce0..de64993d0 100644 --- a/docs.json +++ b/docs.json @@ -22,7 +22,10 @@ { "group": "Editing", "icon": "pen-paintbrush", - "pages": ["development", "web-editor"] + "pages": [ + "development", + "web-editor" + ] }, "settings/global", { @@ -133,7 +136,10 @@ { "group": "Dashboard Access", "icon": "house-lock", - "pages": ["advanced/dashboard/sso", "advanced/dashboard/permissions"] + "pages": [ + "advanced/dashboard/sso", + "advanced/dashboard/permissions" + ] }, { "group": "REST API", @@ -205,7 +211,7 @@ "pages": [ "integrations/analytics/overview", "integrations/analytics/amplitude", - "integrations/analytics/clearbit", + "integrations/analytics/clearbit", "integrations/analytics/fathom", "integrations/analytics/google-analytics", "integrations/analytics/google-tag-manager", @@ -251,7 +257,10 @@ "groups": [ { "group": "Changelog", - "pages": ["changelog/overview"] + "pages": [ + "changelog/overview", + "changelog/overview" + ] } ] } @@ -363,4 +372,4 @@ "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" } } -} +} \ No newline at end of file