diff --git a/changelog/2024-07.mdx b/changelog/2024-07.mdx new file mode 100644 index 000000000..ad0fbe558 --- /dev/null +++ b/changelog/2024-07.mdx @@ -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. diff --git a/changelog/2024-08.mdx b/changelog/2024-08.mdx new file mode 100644 index 000000000..fffb01b19 --- /dev/null +++ b/changelog/2024-08.mdx @@ -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. diff --git a/changelog/2024-09.mdx b/changelog/2024-09.mdx new file mode 100644 index 000000000..d4158ba55 --- /dev/null +++ b/changelog/2024-09.mdx @@ -0,0 +1,23 @@ +--- +title: "September 2024" +description: "Speed improvements and JWT Auth" +--- + +Last updated on: **2024-09-15** + +## 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) diff --git a/changelog/lw/1.mdx b/changelog/lw/1.mdx new file mode 100644 index 000000000..18202e2cf --- /dev/null +++ b/changelog/lw/1.mdx @@ -0,0 +1,41 @@ +--- +title: 'Launch Week I' +description: 'CLI Enhancements, Docs Feedback, Global CSS, API Playground Redesign, Web Editor' +--- + + + + + +## 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) \ No newline at end of file diff --git a/changelog/lw/2.mdx b/changelog/lw/2.mdx new file mode 100644 index 000000000..04c16a7b6 --- /dev/null +++ b/changelog/lw/2.mdx @@ -0,0 +1,41 @@ +--- +title: 'Launch Week II' +description: 'Preview Deployments, Snippets V2, Open-source MDX Engine, Custom JS, Chat Analytics' +--- + + + + + +## 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 `