From ce76c80807ee562aa7dc20af54636a757877e3b9 Mon Sep 17 00:00:00 2001 From: flo merian Date: Fri, 30 Aug 2024 16:56:56 +0200 Subject: [PATCH 01/15] Add tab --- mint.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/mint.json b/mint.json index 32da0865c..b71ca8016 100644 --- a/mint.json +++ b/mint.json @@ -52,6 +52,10 @@ { "name": "Advanced", "url": "advanced" + }, + { + "name": "Changelog", + "url": "changelog.mdx", } ], "navigation": [ @@ -236,4 +240,4 @@ "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" } } -} \ No newline at end of file +} From 9ef06589c62593818fcf60a3746709b06bda6c2b Mon Sep 17 00:00:00 2001 From: flo merian Date: Fri, 30 Aug 2024 16:57:24 +0200 Subject: [PATCH 02/15] Create changelog.mdx --- changelog.mdx | 142 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 142 insertions(+) create mode 100644 changelog.mdx diff --git a/changelog.mdx b/changelog.mdx new file mode 100644 index 000000000..8fa911829 --- /dev/null +++ b/changelog.mdx @@ -0,0 +1,142 @@ +--- +title: 'Product updates' +description: 'What Mintlify recently launched' +--- + +## 2024-07 + +### New ✨ + +- **Mintlify Widget**: 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 β€” **Learn more [here](https://mintlify.com/docs/integrations/widget/chat#installation)**. +- **New Pricing Plan**: We also updated our pricing plans for better customizability and scale β€” **Read the blog announcement [here](https://mintlify.com/blog/pro-plan)**. + +### Improvements πŸ’Ž + +- **API Playground Update**: When you browse API docs, the selected code example now syncs across your pages. + +### [Beta] 🧰 + +- **Insights**: Insights summarizes common user questions and patterns into easy-to-digest reports with AI-powered suggestions on how to improve your product. Currently in beta, want early access? **[Go to your dashboard](https://dashboard.mintlify.com/insights)**. + +--- + +## LAUNCH WEEK III + +- **Themes**: Themes enables you to transform the styling and layout of your documentation to fit your branding. We've unveiled three themes: **[Quill](https://starter-quill.mintlify.app/), [Prism](https://starter-prism.mintlify.app/), and [Venus](https://starter-venus.mintlify.app/).** +- **Search V2**: Upgraded UI, indexing OpenAPI endpoints, removing hidden pages from search, indexing support for components. +- **Web Editor Branching**: Our web editor allows users to alter your docs content right on the web without an IDE. Branches allow you to create separate versions of your documentation without affecting the main project β€” they're like parallel universes for code. +- **User Auth**: When writing documentation, you may want to limit which user guides are shown to your customers. With User Auth, identify your users and tailor your docs content to them. +- **OpenAPI Automations**: When you're constantly shipping changes to your API, it's important to reflect those changes in your documentation ASAP. Our revamped setup makes autogenerating your API Reference docs seamless, removing the need for any manual labor to reflect changes in production + +--- + +## 2024-02 + +### New ✨ + +- **Versioning with Tabs**: We now fully support versioning with tabs β€” **Learn more about this feature [here](https://mintlify.com/docs/settings/versioning#tabs)**. +- **Wildcard redirects**: Now, you can configure a `redirects` section in your `mint.json` to support wildcard redirects β€” **Learn more [here](https://mintlify.com/docs/settings/broken-links#redirects)**. + +### Improvements πŸ’Ž + +- **Dashboard Updates**: We've upgraded the navbar to more readily access support, GitHub app configuration, and user management. Also, we've updated logs to see exactly what was changed and the status of an update. Now, when you make an unsuccessful update, we'll tell you exactly what went wrong. +- **CLI Error Detection Upgrade**: A common issue when updating documentation in markdown is accidentally introducing errors in the metadata. We now show the position of invalid frontmatter when there are parsing issues during local development. + + + To upgrade your CLI, run `npm i -g mintlify@latest`. + + +--- + +## LAUNCH WEEK II + +- **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. +- **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 β€” **Learn more [here](https://mintlify.com/docs/content/reusable-snippets)** +- **Open Source MDX Engine**: You can now integrate our package to access Mintlify-flavored markdown and code syntax highlighting. We welcome contributions β€” **[Star this repo](https://github.com/mintlify/mdx)** +- **Custom JS**: Custom JS allows you to incorporate custom integrations, analytics, and more β€” **Read the related documentation [here](https://mintlify.com/docs/integrations/custom/js)** +- **Chat Analytics**: AI Chat Analytics takes a step forward by providing more detail on what your users as asking as well as how the chatbot responds. Now, you can segment chat history by date, manage your AI Chat usage, and find information about how often a specific query appears. + +--- + +## 2023-11 + +### Improvements πŸ’Ž + +- **API Playground Upgrades**: We've made major improvements to the API Playground, including: + - A Paramfields redesign + - Support for [MDX syntax (Paramfields)](https://mintlify.com/docs/api-playground/components/api/param) + - Support for `readOnly` and `writeOnly` fields +- **Revamped Web Editor**: We've been cooking up some major improvements to the web editor. Now, you can add and delete files/folders, as well as rename them right in the dashboard. + +--- + +## 2023-10 + +### Improvements πŸ’Ž + +- **API Playground Upgrades**: Since the release of the revamped API Playground, we've made some major improvements: + - Persisting authentication tokens + - Automatically prepending `Bearer` for Bearer authentication + - Adding copy & download buttons to API Playground response + - Supporting `additionalProperties` + - Improving API Playground styling capability with background images + +- **CLI Error Handling**:The newest version of our Mintlify CLI is out! Improved error handling allows users to see what pages and lines are throwing parsing errors, allowing for quicker fixes to the documentation. +- **Versioning Revamp**: We've also rolled out a significant improvement in the experience of versioning that handles different editions across anchors. For teams with multiple products across different versions, you'll see an improvement in versioning stability. +- **Linking Multiple Repositories**: For [Pro](https://mintlify.com/pricing) users, we now allow linking multiple repositories to one documentation instance. + + + To upgrade your CLI, run `npm i -g mintlify@latest`. + + +--- + +## LAUNCH WEEK I + +- **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. +- **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. +- **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. +- **API Playground Redesign**: We overhauled the [API Playground](https://mintlify.com/docs/api-playground/overview) for a new and improved design. This upgrade handles edge cases and offers expanded features, including technical functions, effortless UX, and sleek UI. +- **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. + +--- + +## 2023-08 + +### New ✨ + +- **Documentation Feedback**: The new docs feedback configuration allows users to easily indicate whether a page was helpful and suggest edits, creating a direct channel for constructive feedback. With their help, you can better identify new areas of improvement to achieve the best user experience possible β€” **Learn more [here](https://mintlify.com/docs/settings/global#structure)**. + +### Improvements πŸ’Ž + +- **CLI Upgrade**: The newest version of our Mintlify CLI is out! With this upgrade, you can now preview your local changes and enjoy much faster page load speeds. +- **LaTex Support**: We now support LaTeX in our docs. To use them in your interface, use `$` before and after your code to convert it into LateX styling in-line. To create LaTeX in its own line, simply use `$$` before and after your code β€” **Learn more [here](https://mintlify.com/docs/content/text#latex)**. +- **Copying headers from mobile**: Trying to quickly send an anchored link to your docs? You can now copy anchor links from mobile by tapping on the header from mobile. +- **Expanded icon use & icon types**: We now support adding icons onto your sidebar group folders, as well as the various icon types available on [Font Awesome](https://fontawesome.com/icons). Try by adding the `iconType` to your page metadata or sidebar navigation definition. + + + To upgrade your CLI, run `npm i -g mintlify@latest`. + + +--- + +## 2023-07 + +### New ✨ + +- **AI Chat**: Mintlify's AI Chat upgrades your documentation discoverability through a conversational AI search experience. Built with the same technology as ChatGPT, it provides quality and consistent answers to any question your users might have β€” **Read the blog announcement [here](https://mintlify.com/blog/chat)**. + + + To experiment with AI Chat, hit `cmd` + `K`. + + +### Improvements πŸ’Ž + +- **Link Configurations**: If you've changed any documentation page file paths (and subsequently URLs), we now support identifying broken links and maintaining that SEO you've been building. +- **Autogenerating OpenAPI Endpoints**: Tired of manually creating MDX files for every endpoint? We now fully support automated API endpoint documentation β€” **Learn more [here](https://mintlify.com/docs/api-playground/openapi-generation)**. + +--- + +**That's all, folks!** + +Thanks for reading until the bottom of this page β€” you're a true fan β€” and you just found an Easter egg, bravo! πŸŽ‰πŸŽ‰ **[Tweet this!](https://x.com/intent/post?text=%40mintlify+the+smartest+coders+read+the+docs+first)** From a08bacd929368599f15e0209c11ffdf7f423b8a2 Mon Sep 17 00:00:00 2001 From: flo merian Date: Mon, 2 Sep 2024 15:44:40 +0200 Subject: [PATCH 03/15] Update changelog.mdx - Reworked how to display the features launched during launch weeks; - Added `Pro` tags to related updates - Added tips for quick access - Fix typos --- changelog.mdx | 162 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 127 insertions(+), 35 deletions(-) diff --git a/changelog.mdx b/changelog.mdx index 8fa911829..672ba794a 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -3,64 +3,127 @@ title: 'Product updates' description: 'What Mintlify recently launched' --- + + To upgrade your CLI, run the command below. + +``` +npm i -g mintlify@latest +``` + ## 2024-07 -### New ✨ +**New ✨** -- **Mintlify Widget**: 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 β€” **Learn more [here](https://mintlify.com/docs/integrations/widget/chat#installation)**. +- **Mintlify Widget** `Pro`: 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 β€” **Learn more [here](https://mintlify.com/docs/integrations/widget/chat#installation)**. - **New Pricing Plan**: We also updated our pricing plans for better customizability and scale β€” **Read the blog announcement [here](https://mintlify.com/blog/pro-plan)**. -### Improvements πŸ’Ž +**Improvements πŸ’Ž** - **API Playground Update**: When you browse API docs, the selected code example now syncs across your pages. -### [Beta] 🧰 +**Experiment 🧰** -- **Insights**: Insights summarizes common user questions and patterns into easy-to-digest reports with AI-powered suggestions on how to improve your product. Currently in beta, want early access? **[Go to your dashboard](https://dashboard.mintlify.com/insights)**. +- **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. **Want early access? [Go to your dashboard](https://dashboard.mintlify.com/insights)**. --- ## LAUNCH WEEK III -- **Themes**: Themes enables you to transform the styling and layout of your documentation to fit your branding. We've unveiled three themes: **[Quill](https://starter-quill.mintlify.app/), [Prism](https://starter-prism.mintlify.app/), and [Venus](https://starter-venus.mintlify.app/).** -- **Search V2**: Upgraded UI, indexing OpenAPI endpoints, removing hidden pages from search, indexing support for components. -- **Web Editor Branching**: Our web editor allows users to alter your docs content right on the web without an IDE. Branches allow you to create separate versions of your documentation without affecting the main project β€” they're like parallel universes for code. -- **User Auth**: When writing documentation, you may want to limit which user guides are shown to your customers. With User Auth, identify your users and tailor your docs content to them. -- **OpenAPI Automations**: When you're constantly shipping changes to your API, it's important to reflect those changes in your documentation ASAP. Our revamped setup makes autogenerating your API Reference docs seamless, removing the need for any manual labor to reflect changes in production + + + Themes enables you to transform the styling and layout of your documentation to fit your branding. We've unveiled three themes: **[Quill](https://starter-quill.mintlify.app/), [Prism](https://starter-prism.mintlify.app/), and [Venus](https://starter-venus.mintlify.app/).** + + To try out any themes for yourself, just add the following line into your `mint.json` file with any of the following values: + + ``` + "theme": "quill" | "prism" | "venus" + ``` + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-1) + - [View source code on GitHub](https://github.com/mintlify/themes) + + + Upgraded UI, indexing OpenAPI endpoints, removing hidden pages from search, indexing support for components. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-2) + + + The Web Editor allows users to alter your docs content right on the web without an IDE. Branches allow you to create separate versions of your documentation without affecting the main project β€” they're like parallel universes for code. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-3) + + + When writing documentation, you may want to limit which user guides are shown to your customers. With User Auth, identify your users and tailor your docs content to them. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-4) + - [Learn more about User Auth](https://mintlify.com/docs/advanced/user-auth) + + + When you're constantly shipping changes to your API, it's important to reflect those changes in your documentation as soon as possible. Our revamped setup makes autogenerating your API Reference docs seamless, removing the need for any manual labor to reflect changes in production. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-5) + + --- ## 2024-02 -### New ✨ +**New ✨** - **Versioning with Tabs**: We now fully support versioning with tabs β€” **Learn more about this feature [here](https://mintlify.com/docs/settings/versioning#tabs)**. -- **Wildcard redirects**: Now, you can configure a `redirects` section in your `mint.json` to support wildcard redirects β€” **Learn more [here](https://mintlify.com/docs/settings/broken-links#redirects)**. +- **Wildcard Redirects**: Now, you can configure a `redirects` section in your `mint.json` to support wildcard redirects β€” **Learn more [here](https://mintlify.com/docs/settings/broken-links#redirects)**. -### Improvements πŸ’Ž +**Improvements πŸ’Ž** - **Dashboard Updates**: We've upgraded the navbar to more readily access support, GitHub app configuration, and user management. Also, we've updated logs to see exactly what was changed and the status of an update. Now, when you make an unsuccessful update, we'll tell you exactly what went wrong. - **CLI Error Detection Upgrade**: A common issue when updating documentation in markdown is accidentally introducing errors in the metadata. We now show the position of invalid frontmatter when there are parsing issues during local development. - To upgrade your CLI, run `npm i -g mintlify@latest`. + To upgrade your CLI, run the command below. +``` +npm i -g mintlify@latest +``` --- ## LAUNCH WEEK II -- **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. -- **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 β€” **Learn more [here](https://mintlify.com/docs/content/reusable-snippets)** -- **Open Source MDX Engine**: You can now integrate our package to access Mintlify-flavored markdown and code syntax highlighting. We welcome contributions β€” **[Star this repo](https://github.com/mintlify/mdx)** -- **Custom JS**: Custom JS allows you to incorporate custom integrations, analytics, and more β€” **Read the related documentation [here](https://mintlify.com/docs/integrations/custom/js)** -- **Chat Analytics**: AI Chat Analytics takes a step forward by providing more detail on what your users as asking as well as how the chatbot responds. Now, you can segment chat history by date, manage your AI Chat usage, and find information about how often a specific query appears. + + + 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 here](https://mintlify.com/blog/launch-week-2-day-1) + + + Snippets V2 offers more flexibility and performance while being rebuilt from the ground up to resemble the import experience that developers know and love β€” **Learn more [here](https://mintlify.com/docs/content/reusable-snippets)**. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-2) + - [Learn more about Reusable Snippets](https://mintlify.com/docs/reusable-snippets) + + + You can now integrate our package to access Mintlify-flavored markdown and code syntax highlighting. We welcome contributions β€” **[Star this repo](https://github.com/mintlify/mdx)**. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-3) + + + Custom JS allows you to incorporate custom integrations, analytics, and more β€” **Read the related documentation [here](https://mintlify.com/docs/integrations/custom/js)**. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-4) + + + AI Chat Analytics takes a step forward by providing more detail on what your users as asking as well as how the chatbot responds. Now, you can segment chat history by date, manage your AI Chat usage, and find information about how often a specific query appears. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-5) + + --- ## 2023-11 -### Improvements πŸ’Ž +**Improvements πŸ’Ž** - **API Playground Upgrades**: We've made major improvements to the API Playground, including: - A Paramfields redesign @@ -72,7 +135,7 @@ description: 'What Mintlify recently launched' ## 2023-10 -### Improvements πŸ’Ž +**Improvements πŸ’Ž** - **API Playground Upgrades**: Since the release of the revamped API Playground, we've made some major improvements: - Persisting authentication tokens @@ -81,48 +144,77 @@ description: 'What Mintlify recently launched' - Supporting `additionalProperties` - Improving API Playground styling capability with background images -- **CLI Error Handling**:The newest version of our Mintlify CLI is out! Improved error handling allows users to see what pages and lines are throwing parsing errors, allowing for quicker fixes to the documentation. +- **CLI Error Handling**: The newest version of our Mintlify CLI is out! Improved error handling allows users to see what pages and lines are throwing parsing errors, allowing for quicker fixes to the documentation. - **Versioning Revamp**: We've also rolled out a significant improvement in the experience of versioning that handles different editions across anchors. For teams with multiple products across different versions, you'll see an improvement in versioning stability. -- **Linking Multiple Repositories**: For [Pro](https://mintlify.com/pricing) users, we now allow linking multiple repositories to one documentation instance. +- **Linking Multiple Repositories** `Pro`: We now allow linking multiple repositories to one documentation instance. - To upgrade your CLI, run `npm i -g mintlify@latest`. + To upgrade your CLI, run the command below. +``` +npm i -g mintlify@latest +``` --- ## LAUNCH WEEK I -- **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. -- **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. -- **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. -- **API Playground Redesign**: We overhauled the [API Playground](https://mintlify.com/docs/api-playground/overview) for a new and improved design. This upgrade handles edge cases and offers expanded features, including technical functions, effortless UX, and sleek UI. -- **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. + + + 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 here](https://mintlify.com/blog/launch-week-day-1) + + + 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 here](https://mintlify.com/blog/launch-week-day-2) + + + 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 here](https://mintlify.com/blog/launch-week-day-3) + - [Learn more about Custom CSS](https://mintlify.com/docs/advanced/custom/css) + + + We overhauled the [API Playground](https://mintlify.com/docs/api-playground/overview) 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 here](https://mintlify.com/blog/launch-week-day-4) + + + 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 here](https://mintlify.com/blog/launch-week-day-5) + + --- ## 2023-08 -### New ✨ +**New ✨** - **Documentation Feedback**: The new docs feedback configuration allows users to easily indicate whether a page was helpful and suggest edits, creating a direct channel for constructive feedback. With their help, you can better identify new areas of improvement to achieve the best user experience possible β€” **Learn more [here](https://mintlify.com/docs/settings/global#structure)**. -### Improvements πŸ’Ž +**Improvements πŸ’Ž** - **CLI Upgrade**: The newest version of our Mintlify CLI is out! With this upgrade, you can now preview your local changes and enjoy much faster page load speeds. - **LaTex Support**: We now support LaTeX in our docs. To use them in your interface, use `$` before and after your code to convert it into LateX styling in-line. To create LaTeX in its own line, simply use `$$` before and after your code β€” **Learn more [here](https://mintlify.com/docs/content/text#latex)**. -- **Copying headers from mobile**: Trying to quickly send an anchored link to your docs? You can now copy anchor links from mobile by tapping on the header from mobile. +- **Copying Headers from Mobile**: Trying to quickly send an anchored link to your docs? You can now copy anchor links from mobile by tapping on the header from mobile. - **Expanded icon use & icon types**: We now support adding icons onto your sidebar group folders, as well as the various icon types available on [Font Awesome](https://fontawesome.com/icons). Try by adding the `iconType` to your page metadata or sidebar navigation definition. - To upgrade your CLI, run `npm i -g mintlify@latest`. + To upgrade your CLI, run the command below. +``` +npm i -g mintlify@latest +``` --- ## 2023-07 -### New ✨ +**New ✨** - **AI Chat**: Mintlify's AI Chat upgrades your documentation discoverability through a conversational AI search experience. Built with the same technology as ChatGPT, it provides quality and consistent answers to any question your users might have β€” **Read the blog announcement [here](https://mintlify.com/blog/chat)**. @@ -130,7 +222,7 @@ description: 'What Mintlify recently launched' To experiment with AI Chat, hit `cmd` + `K`. -### Improvements πŸ’Ž +**Improvements πŸ’Ž** - **Link Configurations**: If you've changed any documentation page file paths (and subsequently URLs), we now support identifying broken links and maintaining that SEO you've been building. - **Autogenerating OpenAPI Endpoints**: Tired of manually creating MDX files for every endpoint? We now fully support automated API endpoint documentation β€” **Learn more [here](https://mintlify.com/docs/api-playground/openapi-generation)**. From d2d6b9b883dbdc44c1b5a004234c967737f9b540 Mon Sep 17 00:00:00 2001 From: flo merian Date: Mon, 2 Sep 2024 22:08:26 +0200 Subject: [PATCH 04/15] Add Accordion --- changelog.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/changelog.mdx b/changelog.mdx index 672ba794a..0d6f31042 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -229,6 +229,6 @@ npm i -g mintlify@latest --- -**That's all, folks!** - -Thanks for reading until the bottom of this page β€” you're a true fan β€” and you just found an Easter egg, bravo! πŸŽ‰πŸŽ‰ **[Tweet this!](https://x.com/intent/post?text=%40mintlify+the+smartest+coders+read+the+docs+first)** + + Thanks for reading until the bottom of this page β€” you're a true fan β€” and you just found an Easter egg, bravo! πŸŽ‰πŸŽ‰ **[Tweet this!](https://x.com/intent/post?text=%40mintlify+the+smartest+coders+read+the+docs+first)** + From 622249ddb0b04016bd64c4fc2c9a3cfaf6a7d9d6 Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Tue, 3 Sep 2024 01:22:42 -0700 Subject: [PATCH 05/15] fix mint.json --- changelog/product-updates.mdx | 286 ++++++++++++++++++++++++++++++++++ mint.json | 25 ++- 2 files changed, 295 insertions(+), 16 deletions(-) create mode 100644 changelog/product-updates.mdx diff --git a/changelog/product-updates.mdx b/changelog/product-updates.mdx new file mode 100644 index 000000000..6ee0e6185 --- /dev/null +++ b/changelog/product-updates.mdx @@ -0,0 +1,286 @@ +--- +title: "Product updates" +description: "What Mintlify recently launched" +--- + +## 2024-07 + +**New ✨** + +- **Mintlify Widget** `Pro`: 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 β€” **Learn more + [here](https://mintlify.com/docs/integrations/widget/chat#installation)**. +- **New Pricing Plan**: We also updated our pricing plans for better + customizability and scale β€” **Read the blog announcement + [here](https://mintlify.com/blog/pro-plan)**. + +**Improvements πŸ’Ž** + +- **API Playground Update**: When you browse API docs, the selected code example + now syncs across your pages. + +**Experiment 🧰** + +- **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. **Want early access? + [Go to your dashboard](https://dashboard.mintlify.com/insights)**. + +--- + +## LAUNCH WEEK III + + + + Themes enables you to transform the styling and layout of your documentation to fit your branding. We've unveiled three themes: **[Quill](https://starter-quill.mintlify.app/), [Prism](https://starter-prism.mintlify.app/), and [Venus](https://starter-venus.mintlify.app/).** + + To try out any themes for yourself, just add the following line into your `mint.json` file with any of the following values: + + ``` + "theme": "quill" | "prism" | "venus" + ``` + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-1) + - [View source code on GitHub](https://github.com/mintlify/themes) + + + + Upgraded UI, indexing OpenAPI endpoints, removing hidden pages from search, indexing support for components. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-2) + + + + The Web Editor allows users to alter your docs content right on the web without an IDE. Branches allow you to create separate versions of your documentation without affecting the main project β€” they're like parallel universes for code. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-3) + + + + When writing documentation, you may want to limit which user guides are shown to your customers. With User Auth, identify your users and tailor your docs content to them. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-4) + - [Learn more about User Auth](https://mintlify.com/docs/advanced/user-auth) + + + + When you're constantly shipping changes to your API, it's important to reflect those changes in your documentation as soon as possible. Our revamped setup makes autogenerating your API Reference docs seamless, removing the need for any manual labor to reflect changes in production. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-5) + + + + +--- + +## 2024-02 + +**New ✨** + +- **Versioning with Tabs**: We now fully support versioning with tabs β€” **Learn + more about this feature + [here](https://mintlify.com/docs/settings/versioning#tabs)**. +- **Wildcard Redirects**: Now, you can configure a `redirects` section in your + `mint.json` to support wildcard redirects β€” **Learn more + [here](https://mintlify.com/docs/settings/broken-links#redirects)**. + +**Improvements πŸ’Ž** + +- **Dashboard Updates**: We've upgraded the navbar to more readily access + support, GitHub app configuration, and user management. Also, we've updated + logs to see exactly what was changed and the status of an update. Now, when + you make an unsuccessful update, we'll tell you exactly what went wrong. +- **CLI Error Detection Upgrade**: A common issue when updating documentation in + markdown is accidentally introducing errors in the metadata. We now show the + position of invalid frontmatter when there are parsing issues during local + development. + +To upgrade your CLI, run the command below. +``` npm i -g mintlify@latest ``` + +--- + +## LAUNCH WEEK II + + + + 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 here](https://mintlify.com/blog/launch-week-2-day-1) + + + + Snippets V2 offers more flexibility and performance while being rebuilt from the ground up to resemble the import experience that developers know and love β€” **Learn more [here](https://mintlify.com/docs/content/reusable-snippets)**. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-2) + - [Learn more about Reusable Snippets](https://mintlify.com/docs/reusable-snippets) + + + + You can now integrate our package to access Mintlify-flavored markdown and code syntax highlighting. We welcome contributions β€” **[Star this repo](https://github.com/mintlify/mdx)**. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-3) + + + + Custom JS allows you to incorporate custom integrations, analytics, and more β€” **Read the related documentation [here](https://mintlify.com/docs/integrations/custom/js)**. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-4) + + + + AI Chat Analytics takes a step forward by providing more detail on what your users as asking as well as how the chatbot responds. Now, you can segment chat history by date, manage your AI Chat usage, and find information about how often a specific query appears. + + - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-5) + + + + +--- + +## 2023-11 + +**Improvements πŸ’Ž** + +- **API Playground Upgrades**: We've made major improvements to the API + Playground, including: + - A Paramfields redesign + - Support for + [MDX syntax (Paramfields)](https://mintlify.com/docs/api-playground/components/api/param) + - Support for `readOnly` and `writeOnly` fields +- **Revamped Web Editor**: We've been cooking up some major improvements to the + web editor. Now, you can add and delete files/folders, as well as rename them + right in the dashboard. + +--- + +## 2023-10 + +**Improvements πŸ’Ž** + +- **API Playground Upgrades**: Since the release of the revamped API Playground, + we've made some major improvements: + + - Persisting authentication tokens + - Automatically prepending `Bearer` for Bearer authentication + - Adding copy & download buttons to API Playground response + - Supporting `additionalProperties` + - Improving API Playground styling capability with background images + +- **CLI Error Handling**: The newest version of our Mintlify CLI is out! + Improved error handling allows users to see what pages and lines are throwing + parsing errors, allowing for quicker fixes to the documentation. +- **Versioning Revamp**: We've also rolled out a significant improvement in the + experience of versioning that handles different editions across anchors. For + teams with multiple products across different versions, you'll see an + improvement in versioning stability. +- **Linking Multiple Repositories** `Pro`: We now allow linking multiple + repositories to one documentation instance. + +To upgrade your CLI, run the command below. +``` npm i -g mintlify@latest ``` + +--- + +## LAUNCH WEEK I + + + + 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 here](https://mintlify.com/blog/launch-week-day-1) + + + + 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 here](https://mintlify.com/blog/launch-week-day-2) + + + + 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 here](https://mintlify.com/blog/launch-week-day-3) + - [Learn more about Custom CSS](https://mintlify.com/docs/advanced/custom/css) + + + + We overhauled the [API Playground](https://mintlify.com/docs/api-playground/overview) 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 here](https://mintlify.com/blog/launch-week-day-4) + + + + 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 here](https://mintlify.com/blog/launch-week-day-5) + + + + +--- + +## 2023-08 + +**New ✨** + +- **Documentation Feedback**: The new docs feedback configuration allows users + to easily indicate whether a page was helpful and suggest edits, creating a + direct channel for constructive feedback. With their help, you can better + identify new areas of improvement to achieve the best user experience possible + β€” **Learn more [here](https://mintlify.com/docs/settings/global#structure)**. + +**Improvements πŸ’Ž** + +- **CLI Upgrade**: The newest version of our Mintlify CLI is out! With this + upgrade, you can now preview your local changes and enjoy much faster page + load speeds. +- **LaTex Support**: We now support LaTeX in our docs. To use them in your + interface, use `$` before and after your code to convert it into LateX styling + in-line. To create LaTeX in its own line, simply use `$$` before and after + your code β€” **Learn more + [here](https://mintlify.com/docs/content/text#latex)**. +- **Copying Headers from Mobile**: Trying to quickly send an anchored link to + your docs? You can now copy anchor links from mobile by tapping on the header + from mobile. +- **Expanded icon use & icon types**: We now support adding icons onto your + sidebar group folders, as well as the various icon types available on + [Font Awesome](https://fontawesome.com/icons). Try by adding the `iconType` to + your page metadata or sidebar navigation definition. + +To upgrade your CLI, run the command below. +``` npm i -g mintlify@latest ``` + +--- + +## 2023-07 + +**New ✨** + +- **AI Chat**: Mintlify's AI Chat upgrades your documentation discoverability + through a conversational AI search experience. Built with the same technology + as ChatGPT, it provides quality and consistent answers to any question your + users might have β€” **Read the blog announcement + [here](https://mintlify.com/blog/chat)**. + +To experiment with AI Chat, hit `cmd` + `K`. + +**Improvements πŸ’Ž** + +- **Link Configurations**: If you've changed any documentation page file paths + (and subsequently URLs), we now support identifying broken links and + maintaining that SEO you've been building. +- **Autogenerating OpenAPI Endpoints**: Tired of manually creating MDX files for + every endpoint? We now fully support automated API endpoint documentation β€” + **Learn more + [here](https://mintlify.com/docs/api-playground/openapi-generation)**. + +--- + + + Thanks for reading until the bottom of this page β€” you're a true fan β€” and you + just found an Easter egg, bravo! πŸŽ‰πŸŽ‰ **[Tweet + this!](https://x.com/intent/post?text=%40mintlify+the+smartest+coders+read+the+docs+first)** + diff --git a/mint.json b/mint.json index b71ca8016..987b831e1 100644 --- a/mint.json +++ b/mint.json @@ -55,7 +55,7 @@ }, { "name": "Changelog", - "url": "changelog.mdx", + "url": "changelog" } ], "navigation": [ @@ -136,10 +136,7 @@ }, { "group": "SDKs", - "pages": [ - "integrations/sdks/speakeasy", - "integrations/sdks/stainless" - ] + "pages": ["integrations/sdks/speakeasy", "integrations/sdks/stainless"] }, { "group": "Support", @@ -151,17 +148,11 @@ }, { "group": "Privacy", - "pages": [ - "integrations/privacy/overview", - "integrations/privacy/osano" - ] + "pages": ["integrations/privacy/overview", "integrations/privacy/osano"] }, { "group": "Custom Scripts", - "pages": [ - "advanced/custom/css", - "advanced/custom/js" - ] + "pages": ["advanced/custom/css", "advanced/custom/js"] }, { "group": "Custom Subpaths", @@ -172,9 +163,7 @@ }, { "group": "Extensions", - "pages": [ - "advanced/widget/chat" - ] + "pages": ["advanced/widget/chat"] }, { "group": "REST API", @@ -225,6 +214,10 @@ "content/components/expandables", "content/components/sticky-examples" ] + }, + { + "group": "Changelog", + "pages": ["changelog/product-updates"] } ], "footerSocials": { From 7f7fe5912be89087327428e3d381c8af9f3a4af0 Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Tue, 3 Sep 2024 01:52:23 -0700 Subject: [PATCH 06/15] delete changelog --- changelog.mdx | 234 ---------------------------------- changelog/company-updates.mdx | 54 ++++++++ 2 files changed, 54 insertions(+), 234 deletions(-) delete mode 100644 changelog.mdx create mode 100644 changelog/company-updates.mdx diff --git a/changelog.mdx b/changelog.mdx deleted file mode 100644 index 0d6f31042..000000000 --- a/changelog.mdx +++ /dev/null @@ -1,234 +0,0 @@ ---- -title: 'Product updates' -description: 'What Mintlify recently launched' ---- - - - To upgrade your CLI, run the command below. - -``` -npm i -g mintlify@latest -``` - -## 2024-07 - -**New ✨** - -- **Mintlify Widget** `Pro`: 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 β€” **Learn more [here](https://mintlify.com/docs/integrations/widget/chat#installation)**. -- **New Pricing Plan**: We also updated our pricing plans for better customizability and scale β€” **Read the blog announcement [here](https://mintlify.com/blog/pro-plan)**. - -**Improvements πŸ’Ž** - -- **API Playground Update**: When you browse API docs, the selected code example now syncs across your pages. - -**Experiment 🧰** - -- **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. **Want early access? [Go to your dashboard](https://dashboard.mintlify.com/insights)**. - ---- - -## LAUNCH WEEK III - - - - Themes enables you to transform the styling and layout of your documentation to fit your branding. We've unveiled three themes: **[Quill](https://starter-quill.mintlify.app/), [Prism](https://starter-prism.mintlify.app/), and [Venus](https://starter-venus.mintlify.app/).** - - To try out any themes for yourself, just add the following line into your `mint.json` file with any of the following values: - - ``` - "theme": "quill" | "prism" | "venus" - ``` - - - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-1) - - [View source code on GitHub](https://github.com/mintlify/themes) - - - Upgraded UI, indexing OpenAPI endpoints, removing hidden pages from search, indexing support for components. - - - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-2) - - - The Web Editor allows users to alter your docs content right on the web without an IDE. Branches allow you to create separate versions of your documentation without affecting the main project β€” they're like parallel universes for code. - - - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-3) - - - When writing documentation, you may want to limit which user guides are shown to your customers. With User Auth, identify your users and tailor your docs content to them. - - - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-4) - - [Learn more about User Auth](https://mintlify.com/docs/advanced/user-auth) - - - When you're constantly shipping changes to your API, it's important to reflect those changes in your documentation as soon as possible. Our revamped setup makes autogenerating your API Reference docs seamless, removing the need for any manual labor to reflect changes in production. - - - [Read the blog announcement here](https://mintlify.com/blog/launch-week-3-day-5) - - - ---- - -## 2024-02 - -**New ✨** - -- **Versioning with Tabs**: We now fully support versioning with tabs β€” **Learn more about this feature [here](https://mintlify.com/docs/settings/versioning#tabs)**. -- **Wildcard Redirects**: Now, you can configure a `redirects` section in your `mint.json` to support wildcard redirects β€” **Learn more [here](https://mintlify.com/docs/settings/broken-links#redirects)**. - -**Improvements πŸ’Ž** - -- **Dashboard Updates**: We've upgraded the navbar to more readily access support, GitHub app configuration, and user management. Also, we've updated logs to see exactly what was changed and the status of an update. Now, when you make an unsuccessful update, we'll tell you exactly what went wrong. -- **CLI Error Detection Upgrade**: A common issue when updating documentation in markdown is accidentally introducing errors in the metadata. We now show the position of invalid frontmatter when there are parsing issues during local development. - - - To upgrade your CLI, run the command below. - -``` -npm i -g mintlify@latest -``` - ---- - -## LAUNCH WEEK II - - - - 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 here](https://mintlify.com/blog/launch-week-2-day-1) - - - Snippets V2 offers more flexibility and performance while being rebuilt from the ground up to resemble the import experience that developers know and love β€” **Learn more [here](https://mintlify.com/docs/content/reusable-snippets)**. - - - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-2) - - [Learn more about Reusable Snippets](https://mintlify.com/docs/reusable-snippets) - - - You can now integrate our package to access Mintlify-flavored markdown and code syntax highlighting. We welcome contributions β€” **[Star this repo](https://github.com/mintlify/mdx)**. - - - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-3) - - - Custom JS allows you to incorporate custom integrations, analytics, and more β€” **Read the related documentation [here](https://mintlify.com/docs/integrations/custom/js)**. - - - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-4) - - - AI Chat Analytics takes a step forward by providing more detail on what your users as asking as well as how the chatbot responds. Now, you can segment chat history by date, manage your AI Chat usage, and find information about how often a specific query appears. - - - [Read the blog announcement here](https://mintlify.com/blog/launch-week-2-day-5) - - - ---- - -## 2023-11 - -**Improvements πŸ’Ž** - -- **API Playground Upgrades**: We've made major improvements to the API Playground, including: - - A Paramfields redesign - - Support for [MDX syntax (Paramfields)](https://mintlify.com/docs/api-playground/components/api/param) - - Support for `readOnly` and `writeOnly` fields -- **Revamped Web Editor**: We've been cooking up some major improvements to the web editor. Now, you can add and delete files/folders, as well as rename them right in the dashboard. - ---- - -## 2023-10 - -**Improvements πŸ’Ž** - -- **API Playground Upgrades**: Since the release of the revamped API Playground, we've made some major improvements: - - Persisting authentication tokens - - Automatically prepending `Bearer` for Bearer authentication - - Adding copy & download buttons to API Playground response - - Supporting `additionalProperties` - - Improving API Playground styling capability with background images - -- **CLI Error Handling**: The newest version of our Mintlify CLI is out! Improved error handling allows users to see what pages and lines are throwing parsing errors, allowing for quicker fixes to the documentation. -- **Versioning Revamp**: We've also rolled out a significant improvement in the experience of versioning that handles different editions across anchors. For teams with multiple products across different versions, you'll see an improvement in versioning stability. -- **Linking Multiple Repositories** `Pro`: We now allow linking multiple repositories to one documentation instance. - - - To upgrade your CLI, run the command below. - -``` -npm i -g mintlify@latest -``` - ---- - -## LAUNCH WEEK I - - - - 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 here](https://mintlify.com/blog/launch-week-day-1) - - - 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 here](https://mintlify.com/blog/launch-week-day-2) - - - 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 here](https://mintlify.com/blog/launch-week-day-3) - - [Learn more about Custom CSS](https://mintlify.com/docs/advanced/custom/css) - - - We overhauled the [API Playground](https://mintlify.com/docs/api-playground/overview) 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 here](https://mintlify.com/blog/launch-week-day-4) - - - 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 here](https://mintlify.com/blog/launch-week-day-5) - - - ---- - -## 2023-08 - -**New ✨** - -- **Documentation Feedback**: The new docs feedback configuration allows users to easily indicate whether a page was helpful and suggest edits, creating a direct channel for constructive feedback. With their help, you can better identify new areas of improvement to achieve the best user experience possible β€” **Learn more [here](https://mintlify.com/docs/settings/global#structure)**. - -**Improvements πŸ’Ž** - -- **CLI Upgrade**: The newest version of our Mintlify CLI is out! With this upgrade, you can now preview your local changes and enjoy much faster page load speeds. -- **LaTex Support**: We now support LaTeX in our docs. To use them in your interface, use `$` before and after your code to convert it into LateX styling in-line. To create LaTeX in its own line, simply use `$$` before and after your code β€” **Learn more [here](https://mintlify.com/docs/content/text#latex)**. -- **Copying Headers from Mobile**: Trying to quickly send an anchored link to your docs? You can now copy anchor links from mobile by tapping on the header from mobile. -- **Expanded icon use & icon types**: We now support adding icons onto your sidebar group folders, as well as the various icon types available on [Font Awesome](https://fontawesome.com/icons). Try by adding the `iconType` to your page metadata or sidebar navigation definition. - - - To upgrade your CLI, run the command below. - -``` -npm i -g mintlify@latest -``` - ---- - -## 2023-07 - -**New ✨** - -- **AI Chat**: Mintlify's AI Chat upgrades your documentation discoverability through a conversational AI search experience. Built with the same technology as ChatGPT, it provides quality and consistent answers to any question your users might have β€” **Read the blog announcement [here](https://mintlify.com/blog/chat)**. - - - To experiment with AI Chat, hit `cmd` + `K`. - - -**Improvements πŸ’Ž** - -- **Link Configurations**: If you've changed any documentation page file paths (and subsequently URLs), we now support identifying broken links and maintaining that SEO you've been building. -- **Autogenerating OpenAPI Endpoints**: Tired of manually creating MDX files for every endpoint? We now fully support automated API endpoint documentation β€” **Learn more [here](https://mintlify.com/docs/api-playground/openapi-generation)**. - ---- - - - Thanks for reading until the bottom of this page β€” you're a true fan β€” and you just found an Easter egg, bravo! πŸŽ‰πŸŽ‰ **[Tweet this!](https://x.com/intent/post?text=%40mintlify+the+smartest+coders+read+the+docs+first)** - diff --git a/changelog/company-updates.mdx b/changelog/company-updates.mdx new file mode 100644 index 000000000..c164418b6 --- /dev/null +++ b/changelog/company-updates.mdx @@ -0,0 +1,54 @@ +--- +title: "Company updates" +description: Accouncements & Hiring +--- + +## Series A + +By Han Wang + +We're thrilled to announce our Series A led by Andreessen Horowitz with +participation from Bain Capital Ventures, Y Combinator, and others. This +fundraise introduces $18M in new capital, bringing our total fundraising to over +$21M. We welcome Jennifer Li to our board. + +Developers learn how to build software by spending countless hours swimming +through tutorials, quickstart guides, and documentation. We piece together +information to create products that solve problems. Mintlify was founded on the +mission to empower developers with information. + +### The modern developer content platform + +Since launching the product less than two years ago, we've grown to power the +documentation for thousands of the fastest growing startups including Anthropic, +Perplexity, Cursor, Pinecone, Zapier, and over 20% of the last YC batch. + +Today, Mintlify reaches over 20 million developers a year. + +The platform offers a wide range of mission-critical components for +developer-facing teams including: + +Guides API References SDK Libraries Developer-Native Workflow Web-Based Editor +Viewership Analytics User Feedback AI Chat + +And a lot more… + +You can learn more about Mintlify by getting a demo of the product or by trying +it yourself. + +### What's ahead? + +We are in the midst of a reformation in how developers fundamentally interact +with content because of AI. You're probably seeing this already. Every +documentation now needs to have a chatbot to answer questions directly. This is +just the tip of the iceberg. + +You can expect to see a lot of new AI features, changing how content is +maintained and used. Mintlify customers and end-users will be able to accomplish +much more with less. + +This is just the beginning. + +P.S. We're growing fast and hiring for our San Francisco office! If you’re +interested in joining the team, take a look at our careers page or email us +directly at careers@mintlify.com. From bfbc1a95a9fb191dfa912b66529786d29f897a3c Mon Sep 17 00:00:00 2001 From: flo merian Date: Tue, 3 Sep 2024 17:47:03 +0200 Subject: [PATCH 07/15] Add links --- changelog/company-updates.mdx | 50 +++++++++++++++-------------------- 1 file changed, 21 insertions(+), 29 deletions(-) diff --git a/changelog/company-updates.mdx b/changelog/company-updates.mdx index c164418b6..7e1192d4f 100644 --- a/changelog/company-updates.mdx +++ b/changelog/company-updates.mdx @@ -1,54 +1,46 @@ --- title: "Company updates" -description: Accouncements & Hiring +description: "Announcements & Hiring" --- ## Series A -By Han Wang + + By [Han Wang](https://www.linkedin.com/in/handotdev/), Co-founder and CEO. + -We're thrilled to announce our Series A led by Andreessen Horowitz with -participation from Bain Capital Ventures, Y Combinator, and others. This -fundraise introduces $18M in new capital, bringing our total fundraising to over -$21M. We welcome Jennifer Li to our board. +**We're thrilled to announce our Series A led by Andreessen Horowitz with participation from Bain Capital Ventures, Y Combinator, and others.** This fundraise introduces $18M in new capital, bringing our total fundraising to over $21M. We welcome [Jennifer Li](https://www.linkedin.com/in/jenniferhli/) to our board. -Developers learn how to build software by spending countless hours swimming -through tutorials, quickstart guides, and documentation. We piece together -information to create products that solve problems. Mintlify was founded on the -mission to empower developers with information. +Developers learn how to build software by spending countless hours swimming through tutorials, quickstart guides, and documentation. We piece together information to create products that solve problems. Mintlify was founded on the mission to empower developers with information. ### The modern developer content platform -Since launching the product less than two years ago, we've grown to power the -documentation for thousands of the fastest growing startups including Anthropic, -Perplexity, Cursor, Pinecone, Zapier, and over 20% of the last YC batch. +Since launching the product less than two years ago, we've grown to power the documentation for [thousands of the fastest-growing startups](https://mintlify.com/customers) including Anthropic, Perplexity, Cursor, Pinecone, Zapier, and over 20% of the last YC batch. Today, Mintlify reaches over 20 million developers a year. -The platform offers a wide range of mission-critical components for -developer-facing teams including: +The platform offers a wide range of mission-critical components for developer-facing teams including: -Guides API References SDK Libraries Developer-Native Workflow Web-Based Editor -Viewership Analytics User Feedback AI Chat +- Guides +- API References +- SDK Libraries +- Developer-Native Workflow +- Web-Based Editor +- Viewership +- Analytics +- User Feedback +- AI Chat And a lot more… -You can learn more about Mintlify by getting a demo of the product or by trying -it yourself. +You can learn more about Mintlify by [getting a demo](https://mintlify.com/demo) of the product or by [trying it yourself](https://mintlify.com/start). ### What's ahead? -We are in the midst of a reformation in how developers fundamentally interact -with content because of AI. You're probably seeing this already. Every -documentation now needs to have a chatbot to answer questions directly. This is -just the tip of the iceberg. +We're in the midst of a reformation in how developers fundamentally interact with content because of AI. You're probably seeing this already. Every documentation now needs to have a chatbot to answer questions directly. This is just the tip of the iceberg. -You can expect to see a lot of new AI features, changing how content is -maintained and used. Mintlify customers and end-users will be able to accomplish -much more with less. +You can expect to see a lot of new AI features, changing how content is maintained and used. Mintlify customers and end-users will be able to accomplish much more with less. This is just the beginning. -P.S. We're growing fast and hiring for our San Francisco office! If you’re -interested in joining the team, take a look at our careers page or email us -directly at careers@mintlify.com. +P.S. We're growing fast and hiring for our San Francisco office! If you’re interested in joining the team, take a look at our [careers page](https://mintlify.com/careers) or email us directly at [careers@mintlify.com](mailto:careers@mintlify.com). From 38a4bd19a5823ec4e4ad295436fc23148a690eef Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Tue, 3 Sep 2024 12:40:09 -0700 Subject: [PATCH 08/15] delete company updates --- changelog/company-updates.mdx | 54 ----------------------------------- 1 file changed, 54 deletions(-) delete mode 100644 changelog/company-updates.mdx diff --git a/changelog/company-updates.mdx b/changelog/company-updates.mdx deleted file mode 100644 index c164418b6..000000000 --- a/changelog/company-updates.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "Company updates" -description: Accouncements & Hiring ---- - -## Series A - -By Han Wang - -We're thrilled to announce our Series A led by Andreessen Horowitz with -participation from Bain Capital Ventures, Y Combinator, and others. This -fundraise introduces $18M in new capital, bringing our total fundraising to over -$21M. We welcome Jennifer Li to our board. - -Developers learn how to build software by spending countless hours swimming -through tutorials, quickstart guides, and documentation. We piece together -information to create products that solve problems. Mintlify was founded on the -mission to empower developers with information. - -### The modern developer content platform - -Since launching the product less than two years ago, we've grown to power the -documentation for thousands of the fastest growing startups including Anthropic, -Perplexity, Cursor, Pinecone, Zapier, and over 20% of the last YC batch. - -Today, Mintlify reaches over 20 million developers a year. - -The platform offers a wide range of mission-critical components for -developer-facing teams including: - -Guides API References SDK Libraries Developer-Native Workflow Web-Based Editor -Viewership Analytics User Feedback AI Chat - -And a lot more… - -You can learn more about Mintlify by getting a demo of the product or by trying -it yourself. - -### What's ahead? - -We are in the midst of a reformation in how developers fundamentally interact -with content because of AI. You're probably seeing this already. Every -documentation now needs to have a chatbot to answer questions directly. This is -just the tip of the iceberg. - -You can expect to see a lot of new AI features, changing how content is -maintained and used. Mintlify customers and end-users will be able to accomplish -much more with less. - -This is just the beginning. - -P.S. We're growing fast and hiring for our San Francisco office! If you’re -interested in joining the team, take a look at our careers page or email us -directly at careers@mintlify.com. From ee1662f9ccd501d394986b7a3c7dcb78275aeb41 Mon Sep 17 00:00:00 2001 From: flo merian Date: Wed, 4 Sep 2024 10:43:35 +0200 Subject: [PATCH 09/15] Fix links --- changelog/product-updates.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/changelog/product-updates.mdx b/changelog/product-updates.mdx index 6ee0e6185..c7fe23dc6 100644 --- a/changelog/product-updates.mdx +++ b/changelog/product-updates.mdx @@ -25,8 +25,7 @@ description: "What Mintlify recently launched" - **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. **Want early access? - [Go to your dashboard](https://dashboard.mintlify.com/insights)**. + improve your product. --- From bf9f520e9c1555a3c9038181f72a2a34f1bb8839 Mon Sep 17 00:00:00 2001 From: flo merian Date: Wed, 4 Sep 2024 18:19:06 +0200 Subject: [PATCH 10/15] Add notes for 2024-08 --- changelog/product-updates.mdx | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/changelog/product-updates.mdx b/changelog/product-updates.mdx index c7fe23dc6..b9b5c920f 100644 --- a/changelog/product-updates.mdx +++ b/changelog/product-updates.mdx @@ -3,6 +3,34 @@ title: "Product updates" description: "What Mintlify recently launched" --- + + Last updated on: **2024-09-04** + + +## 2024-08 + +**Improvements πŸ’Ž** + +- **Speed Performances**: We made many updates to improve the overall speed for your OpenAPI pages and update workflows. +- **Web Editor**: We polished the UI with new icons and a new layout. +- **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 [here](https://mintlify.com/docs/settings/global#api-configurations)**. +- **AI Chat**: We kept iterating on improving the search experience with more accurate results. +- **Overall UX**: We polished multiple little big UX/UI details. + +**Fixes 🐞** + +- **Search Layout**: The search box is now pixel-perfect on every screen. +- **Anchor Links**: We updated the anchor generation code to support edge cases. +- **API Playground UI**: We fixed a UI bug on the API Playground when switching tabs. +- **Sidebar**: We also squashed a bug with sidebar items. +- **Code Groups**: We fixed how the component behaves. + +**Experiment 🧰** + +- **Web Editor V2**: Spoiler alert. We're currently exploring options to enhance the experience of the Web Editor. Among them are an image uploader and a WYSIWYG experience. + +--- + ## 2024-07 **New ✨** From b421ab1da692f59cf3feebd1aa6d434e07f8f652 Mon Sep 17 00:00:00 2001 From: flo merian Date: Tue, 10 Sep 2024 15:50:57 +0200 Subject: [PATCH 11/15] Update changelog --- changelog/2024-08.mdx | 25 +++ changelog/2024-09.mdx | 31 +++ changelog/lw/1.mdx | 41 ++++ changelog/lw/2.mdx | 41 ++++ changelog/lw/3.mdx | 46 ++++ changelog/product-updates.mdx | 313 ---------------------------- images/changelog/launch-week-1.png | Bin 0 -> 10745642 bytes images/changelog/launch-week-2.jpeg | Bin 0 -> 145878 bytes images/changelog/launch-week-3.png | Bin 0 -> 171337 bytes mint.json | 15 +- 10 files changed, 197 insertions(+), 315 deletions(-) create mode 100644 changelog/2024-08.mdx create mode 100644 changelog/2024-09.mdx create mode 100644 changelog/lw/1.mdx create mode 100644 changelog/lw/2.mdx create mode 100644 changelog/lw/3.mdx delete mode 100644 changelog/product-updates.mdx create mode 100644 images/changelog/launch-week-1.png create mode 100644 images/changelog/launch-week-2.jpeg create mode 100644 images/changelog/launch-week-3.png diff --git a/changelog/2024-08.mdx b/changelog/2024-08.mdx new file mode 100644 index 000000000..9f7786199 --- /dev/null +++ b/changelog/2024-08.mdx @@ -0,0 +1,25 @@ +--- +title: 'Product Updates 2024-08' +description: 'Introducing the Mintlify Widget and the Pro plan' +--- + +## Mintlify Widget + +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 Update + +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. \ No newline at end of file diff --git a/changelog/2024-09.mdx b/changelog/2024-09.mdx new file mode 100644 index 000000000..7ab02e121 --- /dev/null +++ b/changelog/2024-09.mdx @@ -0,0 +1,31 @@ +--- +title: 'Product Updates 2024-09' +description: 'Speed improvements, Web Editor UI, and AI Chat' +--- + +## Speed Performances + +We made many updates to improve the overall speed for your OpenAPI pages and update workflows. + +## Web Editor UI + +We polished the UI with new icons and a new layout. + +## 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) + +## AI Chat + +We kept iterating on improving the search experience with more accurate results. + +## More + +- **Overall UX**: We polished multiple little big UX/UI details. +- **Search Layout**: The search box is now pixel-perfect on every screen. +- **Anchor Links**: We updated the anchor generation code to support edge cases. +- **API Playground UI**: We fixed a UI bug on the API Playground when switching tabs. +- **Sidebar**: We also squashed a bug with sidebar items. +- **Code Groups**: We fixed how the component behaves. \ No newline at end of file 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 `