From 71978f3a7d1ea91deae2f8a9c54bd567f581c977 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 22 Nov 2024 19:53:29 +0000 Subject: [PATCH] Documentation edits made through Mintlify web editor --- changelog/overview.mdx | 322 ++++++++++++++++++++++------------------- 1 file changed, 174 insertions(+), 148 deletions(-) diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 09e66ea7..1bce721f 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -5,233 +5,259 @@ mode: "wide" --- -## Web Editor - - Web Editor - -We've revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown. + ## GitLab Integration Upgrade -Check out our [docs on getting started with Web Editor](/web-editor). + ![](gitlab_support.jpg) -## /llms.txt support - - llms.txt support - -All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org) + We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out [our docs on GitLab](https://mintlify.com/docs/settings/gitlab#gitlab) to get started. + ## Web Editor -## Localization -You can now localize your docs which operates similarly to versioning. Add a `locale` to a version and fixed content in Mintlify like "Was this page helpful?" will also match the locale. + + Web Editor + + We've revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown. + + Check out our [docs on getting started with Web Editor](/web-editor). + + ## /llms.txt support + + + llms.txt support + + + All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org) + + ## Localization + + You can now localize your docs which operates similarly to versioning. Add a `locale` to a version and fixed content in Mintlify like "Was this page helpful?" will also match the locale. + ## Changelogs + + Launched a new [Update component](/content/components/update) to make it easier to display and report updates (like this one) to your users. + + + Changelog + + + ## Code Line Highlighting + + You can now highlight lines of code in your docs to emphasize and bring attention to important parts by adding a special comment after the language identifier. Use curly braces `{}` and specify line numbers or ranges separated by commas. + + ```javascript Line Highlighting Example {1,3-5} + const greeting = "Hello, World!"; + function sayHello() { + console.log(greeting); + } + sayHello(); + ``` + + ````md + ```javascript Line Highlighting Example {1,3-5} + const greeting = "Hello, World!"; + function sayHello() { + console.log(greeting); + } + sayHello(); + ``` + ```` + + ## Light mode code blocks -## Changelogs + Code blocks now have a light mode variant which can be enabled by adding the following to your `mint.json`: -Launched a new [Update component](/content/components/update) to make it easier to display and report updates (like this one) to your users. + ```json + "codeBlock": { + "mode": "auto" + } + ``` - - Changelog - + ## Advanced Footer + + Advanced Footer + -## Code Line Highlighting + You can now add more links to the standard footer. This upgrade + provides more consistency between landing pages and docs, or greater customization + if you want to spotlight specific pages like socials or status logs. -You can now highlight lines of code in your docs to emphasize and bring attention to important parts by adding a special comment after the language identifier. Use curly braces `{}` and specify line numbers or ranges separated by commas. + ## Filter search based on the current user -```javascript Line Highlighting Example {1,3-5} -const greeting = "Hello, World!"; -function sayHello() { - console.log(greeting); -} -sayHello(); -``` + When user auth is enabled, search results are now filtered based on the current logged in user so that they only see the relevant content. -````md -```javascript Line Highlighting Example {1,3-5} -const greeting = "Hello, World!"; -function sayHello() { - console.log(greeting); -} -sayHello(); -``` -```` + ## Custom Prompts for AI Chat -## Light mode code blocks + You can now customize the prompts for the AI chat. Please reach out to [support](mailto:sales@mintlify.com) if you'd like to customize the prompts. -Code blocks now have a light mode variant which can be enabled by adding the following to your `mint.json`: + ## Dashboard Improvements -```json -"codeBlock": { - "mode": "auto" -} -``` + * Added ability to change custom domain to be /docs directly through dashboard settings. -## Advanced Footer + * Consolidated the login and signup pages to decrease friction and confusion. - - Advanced Footer - + * Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them. -You can now add more links to the standard footer. This upgrade -provides more consistency between landing pages and docs, or greater customization -if you want to spotlight specific pages like socials or status logs. + * Added login with Google OAuth -## Filter search based on the current user + * Added ability to add new deployment through dashboard settings. -When user auth is enabled, search results are now filtered based on the current logged in user so that they only see the relevant content. + ## Bug Fixes -## Custom Prompts for AI Chat + * Can now use leading slashes in navigation. -You can now customize the prompts for the AI chat. Please reach out to [support](mailto:sales@mintlify.com) if you'd like to customize the prompts. + * Can now edit CSS & JS files in the web editor. -## Dashboard Improvements + * Fixed `suggestEdit` not showing up even when enabled. -- Added ability to change custom domain to be /docs directly through dashboard settings. -- Consolidated the login and signup pages to decrease friction and confusion. -- Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them. -- Added login with Google OAuth -- Added ability to add new deployment through dashboard settings. + * Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results. -## Bug Fixes + * Don't allow search engines to crawl user-auth protected pages. -- Can now use leading slashes in navigation. -- Can now edit CSS & JS files in the web editor. -- Fixed `suggestEdit` not showing up even when enabled. -- Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results. -- Don't allow search engines to crawl user-auth protected pages. -- Revalidate the cache when an org is deleted. -- We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages. -- Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions. -- Add in-line-style support for icons -- Fixed the pop-in of custom CSS in docs. -- Properly show in-line code styling in conjunction with links. -- Maintain scroll position when you click the back button in a browser. + * Revalidate the cache when an org is deleted. + * We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages. + + * Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions. + + * Add in-line-style support for icons + + * Fixed the pop-in of custom CSS in docs. + + * Properly show in-line code styling in conjunction with links. + + * Maintain scroll position when you click the back button in a browser. ## Custom Fonts - - Custom Fonts - + + Custom Fonts + Personalize the font of your docs to your own font hosted on a CDN or by choosing from Google fonts to match your docs with your brand. -## Images in Card components + ## Images in Card components + + Add an `img` property to a card to display an image on the top of the card. Learn more about it [here](/content/components/cards#image-card). + + ## Update Speed Performances -Add an `img` property to a card to display an image on the top of the card. Learn more about it [here](/content/components/cards#image-card). + + Performance Improvements + -## 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. - - Performance Improvements - + ## SEO improvements -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. + + SEO Improvements + -## SEO improvements + We've fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements. - - SEO Improvements - + ## Dashboard Improvements -We've fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements. + * App router migration in the dashboard. -## Dashboard Improvements + * Search analytics are now available in the dashboard. -- App router migration in the dashboard. -- Search analytics are now available in the dashboard. -- Delete an org functionality has been added to the dashboard. -- Shipped GitLab connection UI. -- Fix incorrect analytics data. -- Add-on's can now be directly purchased through the dashboard. + * Delete an org functionality has been added to the dashboard. -## Bug Fixes + * Shipped GitLab connection UI. -- Fixed a bug where the top bar would not stretch to the width of the screen when it's in custom mode and the sidebar layout is `sidenav`. -- Fix relative positioning of the AI widget. + * Fix incorrect analytics data. -## More + * Add-on's can now be directly purchased through the dashboard. -- **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) + ## Bug Fixes + + * Fixed a bug where the top bar would not stretch to the width of the screen when it's in custom mode and the sidebar layout is `sidenav`. + + * Fix relative positioning of the AI widget. + + ## 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) + ## OpenAPI Reference Pages -## OpenAPI Reference Pages + * Endpoints defined by OpenAPI that are complex and recursive are now 98% + smaller. -- 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. + * We now show + [additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/) + in OpenAPI pages. -## File Uploads in API Playground + ## File Uploads in API Playground -By default, API playground requests are proxied by Mintlify. Now you can use -`disableProxy` to disable this behavior and support request types like file -uploads. + 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) + * [Learn more about API configurations](/settings/global#api-configurations) -## Mobile SEO improvements + ## 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. + We've fixed the mobile layout of our docs so that they are more SEO-friendly - + including adding proper aria tags to elements. -## Support Form + ## Support Form -We added a more detailed support form to the Mintlify dashboard. You can now -submit a form to get in touch with us. + We added a more detailed support form to the Mintlify dashboard. You can now + submit a form to get in touch with us. -## Bug Fixes + ## Bug Fixes -- Fixed a bug for the Segment integration functionality. -- 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. + * 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. + ## AI Widget -## AI Widget - - - AI Widget - + + AI 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. + 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) + * [Read the blog announcement](https://mintlify.com/blog/widget) -## Pro Plan + * [Learn how to install the Widget](/advanced/widget/chat#getting-started) -We also updated our pricing plans for better customizability and scale. + ## Pro Plan -- [Read the blog announcement](https://mintlify.com/blog/pro-plan) + We also updated our pricing plans for better customizability and scale. -## API Playground Code Example Sync + * [Read the blog announcement](https://mintlify.com/blog/pro-plan) -When you browse API docs, the selected code example now syncs across your pages. + ## API Playground Code Example Sync -## Insights + When you browse API docs, the selected code example now syncs across your pages. -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. + ## 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