diff --git a/advanced/rest-api/overview.mdx b/advanced/rest-api/overview.mdx index 49b281047..d0b951db9 100644 --- a/advanced/rest-api/overview.mdx +++ b/advanced/rest-api/overview.mdx @@ -6,12 +6,12 @@ title: Introduction The Mintlify REST API is only available on the startup plan and above. -Leverage the external API to programmatically trigger an update when desired. +🚀 Leverage the external API to programmatically trigger an update when desired. The primary use-case will be to trigger updates. We will be adding more and more -functionality to the API overtime. Let us know what else you want to see in +functionality to the API overtime. 💡 Let us know what else you want to see in [our community](https://mintlify.com/community)! -## Authentication +## Authentication 🔐 You can generate an API key through [the dashboard](https://dashboard.mintlify.com/settings/integrations). The API key is @@ -20,3 +20,5 @@ associated with the entire org and can be used across multiple deployments. + + \ No newline at end of file diff --git a/api-playground/overview.mdx b/api-playground/overview.mdx index c222ffedf..f1b0d2d04 100644 --- a/api-playground/overview.mdx +++ b/api-playground/overview.mdx @@ -1,15 +1,15 @@ --- -title: 'Interactive Playground' +title: '🎮 Interactive Playground' description: 'Enable users to interact with your API' openapi: 'GET /plants/{id}' hideApiMarker: true icon: 'play' --- -The API playground is an interactive environment to make requests and preview an API endpoint. +The API playground is an interactive environment to make requests and preview an API endpoint. 🚀 - Autogenerating API pages with OpenAPI will automatically generate API + ✨ Autogenerating API pages with OpenAPI will automatically generate API playground. Read more about using OpenAPI with Mintlify [here](/api-playground/openapi). - + \ No newline at end of file diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 22d83458a..8d047cb8f 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -5,7 +5,7 @@ mode: "wide" --- - ## AI Assistant + ## 🤖 AI Assistant AI Assistant @@ -13,11 +13,11 @@ mode: "wide" You can now ask AI to make changes to your docs, with the context of all existing documentation. Type in a prompt and the assistant will propose changes by generating a pull request. - ## GitLab Integration Upgrade + ## 🔄 GitLab Integration Upgrade We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/settings/gitlab) to get started. - ## Web Editor + ## ✍️ Web Editor Web Editor @@ -27,7 +27,7 @@ mode: "wide" Check out our [docs on getting started with Web Editor](/web-editor). - ## /llms.txt support + ## 🧠 /llms.txt support llms.txt support @@ -35,11 +35,11 @@ mode: "wide" 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 + ## 🌍 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. - ### Quality Improvements + ### ⭐️ Quality Improvements * Return chat & search results based on the current version that the user is reading @@ -47,7 +47,7 @@ mode: "wide" - ## Changelogs + ## 📝 Changelogs Launched a new [Update component](/content/components/update) to make it easier to display and report updates (like this one) to your users. @@ -55,7 +55,7 @@ mode: "wide" Changelog - ## Code Line Highlighting + ## ✨ Code Line Highlighting You can now highlight lines of code in your docs to emphasize and bring attention to important parts by adding a special comment after the language identifier. Use curly braces `{}` and specify line numbers or ranges separated by commas. @@ -77,7 +77,7 @@ mode: "wide" ``` ```` - ## Light mode code blocks + ## 💡 Light mode code blocks Code blocks now have a light mode variant which can be enabled by adding the following to your `mint.json`: @@ -87,7 +87,7 @@ mode: "wide" } ``` - ## Advanced Footer + ## 🎨 Advanced Footer Advanced Footer @@ -97,15 +97,15 @@ mode: "wide" provides more consistency between landing pages and docs, or greater customization if you want to spotlight specific pages like socials or status logs. - ## Filter search based on the current user + ## 🔍 Filter search based on the current user 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. - ## Custom Prompts for AI Chat + ## 💬 Custom Prompts for AI Chat You can now customize the prompts for the AI chat. Please reach out to [support](mailto:sales@mintlify.com) if you'd like to customize the prompts. - ## Dashboard Improvements + ## 📊 Dashboard Improvements * Added ability to change custom domain to be /docs directly through dashboard settings. @@ -117,7 +117,7 @@ mode: "wide" * Added ability to add new deployment through dashboard settings. - ## Bug Fixes + ## 🐛 Bug Fixes * Can now use leading slashes in navigation. @@ -145,7 +145,7 @@ mode: "wide" - ## Custom Fonts + ## 🎯 Custom Fonts Custom Fonts @@ -153,11 +153,11 @@ mode: "wide" 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 + ## ⚡️ Update Speed Performances Performance Improvements @@ -167,7 +167,7 @@ mode: "wide" \~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 SEO Improvements @@ -175,7 +175,7 @@ mode: "wide" We've fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements. - ## Dashboard Improvements + ## 📱 Dashboard Improvements * App router migration in the dashboard. @@ -189,13 +189,13 @@ mode: "wide" * Add-on's can now be directly purchased through the dashboard. - ## Bug Fixes + ## 🔧 Bug Fixes * Fixed a bug where the top bar would not stretch to the width of the screen when it's in custom mode and the sidebar layout is `sidenav`. * Fix relative positioning of the AI widget. - ## More + ## ✨ More * **Troubleshooting for API pages**: API pages could be complicated so we listed common issues to help you sort them out quickly — @@ -203,7 +203,7 @@ mode: "wide" - ## OpenAPI Reference Pages + ## 📚 OpenAPI Reference Pages * Endpoints defined by OpenAPI that are complex and recursive are now 98% smaller. @@ -212,7 +212,7 @@ mode: "wide" [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 @@ -220,17 +220,17 @@ mode: "wide" * [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. - ## Support Form + ## 💌 Support Form We added a more detailed support form to the Mintlify dashboard. You can now submit a form to get in touch with us. - ## Bug Fixes + ## 🐛 Bug Fixes * Fixed a bug for the Segment integration functionality. @@ -242,7 +242,7 @@ mode: "wide" - ## AI Widget + ## 🤖 AI Widget AI Widget @@ -257,17 +257,17 @@ mode: "wide" * [Learn how to install the Widget](/advanced/widget/chat#getting-started) - ## Pro Plan + ## ⭐️ Pro Plan We also updated our pricing plans for better customizability and scale. * [Read the blog announcement](https://mintlify.com/blog/pro-plan) - ## API Playground Code Example Sync + ## 🔄 API Playground Code Example Sync When you browse API docs, the selected code example now syncs across your pages. - ## 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 diff --git a/content/components/update.mdx b/content/components/update.mdx index f2bad5866..938218163 100644 --- a/content/components/update.mdx +++ b/content/components/update.mdx @@ -1,10 +1,10 @@ --- -title: "Update" -description: "Keep track of changes and updates" +title: "Update 📝" +description: "Keep track of changes and updates ⏱️" icon: "rectangle-history" --- -The `Update` component is used to keep track of changes and updates. +The `Update` component is used to keep track of changes and updates 📊 @@ -14,17 +14,17 @@ The `Update` component is used to keep track of changes and updates. /> - ## Changelog + ## Changelog 📋 You can add anything here, like a screenshot, a code snippet, or a list of changes. - #### Features - - Responsive design - - Sticky section for each changelog + #### Features ✨ + - Responsive design 📱 + - Sticky section for each changelog 📌 - ### How to use + ### How to use 🛠️ ```md This is how you use a changelog with a label @@ -36,19 +36,21 @@ The `Update` component is used to keep track of changes and updates. ``` - You can use multiple `Update` components to create changelogs. + You can use multiple `Update` components to create changelogs ✨ - Each `label` creates an anchor and also shows up on the table of contents on the right. + 💡 Each `label` creates an anchor and also shows up on the table of contents on the right. -## Props +## Props 🔧 - Label in the changelog, on the sticky left side. + Label in the changelog, on the sticky left side 📍 - Description below the label in the Changelog preview. + Description below the label in the Changelog preview 📝 + + \ No newline at end of file diff --git a/integrations/privacy/overview.mdx b/integrations/privacy/overview.mdx index 737baebe5..f8d785bfa 100644 --- a/integrations/privacy/overview.mdx +++ b/integrations/privacy/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Privacy Integrations" -description: "Integrate with a data privacy platform" +title: "Privacy Integrations 🔐" +description: "Integrate with a data privacy platform 🛡️" --- @@ -13,9 +13,9 @@ description: "Integrate with a data privacy platform" -## Enabling Data Privacy Integrations +## Enabling Data Privacy Integrations 🔒 -You can add data privacy platforms onto your docs. Add the `integrations` field into your `mint.json` file with your respective scripts. +You can add data privacy platforms onto your docs. Add the `integrations` field into your `mint.json` file with your respective scripts. ✨ ```json "integrations": { @@ -23,4 +23,6 @@ You can add data privacy platforms onto your docs. Add the `integrations` field } ``` -If you'd like to request a data privacy platform integration, please let us know in [our community](https://mintlify.com/community). +If you'd like to request a data privacy platform integration, please let us know in [our community](https://mintlify.com/community) 💬 + + \ No newline at end of file diff --git a/integrations/support/overview.mdx b/integrations/support/overview.mdx index 71be4aa65..037c3138f 100644 --- a/integrations/support/overview.mdx +++ b/integrations/support/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Support Integrations" -description: "Integrate with a support widget" +title: "Support Integrations 🤝" +description: "Integrate with a support widget 💬" --- @@ -28,14 +28,13 @@ description: "Integrate with a support widget" - -} +} horizontal > -## Enabling Support Integrations +## Enabling Support Integrations ⚙️ You can integrate widgets onto your docs for customer support. Add the `integrations` field into your `mint.json` file with your respective app ID. @@ -46,4 +45,5 @@ You can integrate widgets onto your docs for customer support. Add the `integrat } ``` -If you'd like to request a customer support integration, please let us know in [our community](https://join.slack.com/t/mintlify-users/shared_invite/zt-1xfzz6x35-f4o4WCYfpvLhSj3O7WAOMA). +If you'd like to request a customer support integration, please let us know in [our community](https://join.slack.com/t/mintlify-users/shared_invite/zt-1xfzz6x35-f4o4WCYfpvLhSj3O7WAOMA) 👋 + \ No newline at end of file