-
Notifications
You must be signed in to change notification settings - Fork 208
feat: Add changelog #262
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
feat: Add changelog #262
Changes from 4 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
ce76c80
Add tab
fmerian 9ef0658
Create changelog.mdx
fmerian a08bacd
Update changelog.mdx
fmerian d2d6b9b
Add Accordion
fmerian 622249d
fix mint.json
hahnbeelee 7f7fe59
delete changelog
hahnbeelee bfbc1a9
Add links
fmerian 38a4bd1
delete company updates
hahnbeelee 1328abb
Merge branch '261-add-changelog' of https://github.com/mintlify/docs …
hahnbeelee ee1662f
Fix links
fmerian bf9f520
Add notes for 2024-08
fmerian b421ab1
Update changelog
fmerian f7052c6
Update changelog titles
fmerian 6fe8b73
Add changelog 2024-09
fmerian 8971b3b
go thru mint prs & add to log
hahnbeelee d4d765e
fix title
hahnbeelee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,234 @@ | ||
--- | ||
title: 'Product updates' | ||
description: 'What Mintlify recently launched' | ||
--- | ||
|
||
<Tip> | ||
To upgrade your CLI, run the command below. | ||
</Tip> | ||
``` | ||
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 | ||
|
||
<AccordionGroup> | ||
<Accordion title="Themes — Customizations to make your content stand out"> | ||
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) | ||
</Accordion> | ||
<Accordion title="Search V2 — Find what you're looking for"> | ||
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) | ||
</Accordion> | ||
<Accordion title="Web Editor Branching — Draft functionality for the Web Editor"> | ||
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) | ||
</Accordion> | ||
<Accordion title="User Auth — Pre-fill API Keys and customize MDX content"> | ||
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) | ||
</Accordion> | ||
<Accordion title="OpenAPI Automations — Improve dev workflows for communicating API changes"> | ||
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) | ||
</Accordion> | ||
</AccordionGroup> | ||
|
||
--- | ||
|
||
## 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. | ||
|
||
<Tip> | ||
To upgrade your CLI, run the command below. | ||
</Tip> | ||
``` | ||
npm i -g mintlify@latest | ||
``` | ||
|
||
--- | ||
|
||
## LAUNCH WEEK II | ||
|
||
<AccordionGroup> | ||
<Accordion title="Preview Deployments — See your production docs before they go live"> | ||
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) | ||
</Accordion> | ||
<Accordion title="Snippets V2 — Enhanced snippets to reuse components and variables"> | ||
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) | ||
</Accordion> | ||
<Accordion title="Open Source MDX Engine — Build your blog with Mintlify MDX"> | ||
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) | ||
</Accordion> | ||
<Accordion title="Custom JS — Add custom integrations and analytics"> | ||
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) | ||
</Accordion> | ||
<Accordion title="Chat Analytics — Analyze how people use the AI Chat"> | ||
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) | ||
</Accordion> | ||
</AccordionGroup> | ||
|
||
--- | ||
|
||
## 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. | ||
|
||
<Tip> | ||
To upgrade your CLI, run the command below. | ||
</Tip> | ||
``` | ||
npm i -g mintlify@latest | ||
``` | ||
|
||
--- | ||
|
||
## LAUNCH WEEK I | ||
|
||
<AccordionGroup> | ||
<Accordion title="CLI Enhancements — Faster, more efficient user experience"> | ||
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) | ||
</Accordion> | ||
<Accordion title="Docs Feedback — Improve your docs with direct user 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 here](https://mintlify.com/blog/launch-week-day-2) | ||
</Accordion> | ||
<Accordion title="Global CSS — Customize your docs design"> | ||
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) | ||
</Accordion> | ||
<Accordion title="API Playground Redesign — New user experience"> | ||
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) | ||
</Accordion> | ||
<Accordion title="Web Editor — Edit, preview, and commit on the dashboard"> | ||
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) | ||
</Accordion> | ||
</AccordionGroup> | ||
|
||
--- | ||
|
||
## 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. | ||
|
||
<Tip> | ||
To upgrade your CLI, run the command below. | ||
</Tip> | ||
``` | ||
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)**. | ||
|
||
<Tip> | ||
To experiment with AI Chat, hit `cmd` + `K`. | ||
</Tip> | ||
|
||
**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)**. | ||
|
||
--- | ||
|
||
<Accordion title="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)** | ||
</Accordion> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.