From a0e83acd70b57517f21193f3c10093a41fee0bae Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 25 Nov 2024 16:37:26 +0000 Subject: [PATCH] Documentation edits made through Mintlify web editor --- advanced/rest-api/overview.mdx | 4 +- advanced/user-auth/overview.mdx | 5 +- changelog/overview.mdx | 123 +++++++++++++------------------- mint.json | 19 +++-- 4 files changed, 70 insertions(+), 81 deletions(-) diff --git a/advanced/rest-api/overview.mdx b/advanced/rest-api/overview.mdx index 49b281047..5ecc23d2a 100644 --- a/advanced/rest-api/overview.mdx +++ b/advanced/rest-api/overview.mdx @@ -8,7 +8,7 @@ title: Introduction 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 through over time. Let us know what else you want to see in [our community](https://mintlify.com/community)! ## Authentication @@ -19,4 +19,4 @@ associated with the entire org and can be used across multiple deployments. - + \ No newline at end of file diff --git a/advanced/user-auth/overview.mdx b/advanced/user-auth/overview.mdx index 06038cb5b..9b8cdd21e 100644 --- a/advanced/user-auth/overview.mdx +++ b/advanced/user-auth/overview.mdx @@ -3,7 +3,7 @@ title: 'Introduction' description: 'Give your users a personalized docs experience' --- -User Auth allows you to identify and authenticate your users so that you can personalize docs content for them. your users. +User Auth allows you to identify and authenticate your users so that you can personalize docs content for them. Example use cases: @@ -59,6 +59,7 @@ User Auth is an enterprise feature. { ### Prefilling API Keys If you return API Playground inputs in the user info, they will automatically be prefilled in the API Playground. Make sure the name of the field in the user info is an exact match of the name in the API Playground. + ### Showing/Hiding Pages By default, every page is visible to every user. If you want to restrict which pages are visible to your users, you can add a `groups` field in your page metadata. @@ -82,3 +83,5 @@ Here's a table that displays whether a page is shown for different combinations | `groups: ['admin']` in metadata | ❌ | ❌ | ✅ | Note that an empty array in the page metadata is interpreted as "No groups should see this page." + + \ No newline at end of file diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 09e66ea7a..f10cedfbc 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -13,15 +13,14 @@ We've revamped our web editor so that you can now update docs with a fully WYSIW Check out our [docs on getting started with Web Editor](/web-editor). -## /llms.txt support +## /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) - +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. +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. @@ -35,7 +34,6 @@ Launched a new [Update component](/content/components/update) to make it easier 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. @@ -58,7 +56,7 @@ sayHello(); ``` ```` -## 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`: @@ -74,13 +72,11 @@ Code blocks now have a light mode variant which can be enabled by adding the fol Advanced Footer -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 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. -## Filter search based on the current user +## Filter Search Based on 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. +When user auth is enabled, search results are now filtered based on the current logged-in user so that they only see relevant content. ## Custom Prompts for AI Chat @@ -88,117 +84,103 @@ You can now customize the prompts for the AI chat. Please reach out to [support] ## Dashboard Improvements -- 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 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 who are members of multiple organizations can now switch between them - Added login with Google OAuth -- Added ability to add new deployment through dashboard settings. +- Added ability to add new deployment through dashboard settings ## Bug Fixes -- 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. +- 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 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. +- 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. +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 Performance Performance 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. +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 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. +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 -- 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. +- 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 +- Fixed incorrect analytics data +- Add-ons can now be directly purchased through the dashboard ## 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. +- 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` +- Fixed 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) +- **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 -- 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. +- Endpoints defined by OpenAPI that are complex and recursive are now 98% smaller +- We now show [additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/) in OpenAPI pages ## File Uploads in API Playground -By default, API playground requests are proxied by Mintlify. Now you can use -`disableProxy` to disable this behavior and support request types like file -uploads. +By default, API playground requests are proxied by Mintlify. Now you can use `disableProxy` to disable this behavior and support request types like file uploads. - [Learn more about API configurations](/settings/global#api-configurations) -## Mobile SEO improvements +## 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 -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 -- 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 @@ -210,10 +192,7 @@ submit a form to get in touch with us. 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) @@ -230,8 +209,6 @@ 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. +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/mint.json b/mint.json index 0636b0312..b6e13a7db 100644 --- a/mint.json +++ b/mint.json @@ -122,7 +122,8 @@ }, { "group": "Advanced", - "pages": [{ + "pages": [ + { "icon": "code", "group": "Custom Scripts", "pages": [ @@ -196,7 +197,10 @@ }, { "group": "SDKs", - "pages": ["integrations/sdks/speakeasy", "integrations/sdks/stainless"] + "pages": [ + "integrations/sdks/speakeasy", + "integrations/sdks/stainless" + ] }, { "group": "Support", @@ -208,7 +212,10 @@ }, { "group": "Privacy", - "pages": ["integrations/privacy/overview", "integrations/privacy/osano"] + "pages": [ + "integrations/privacy/overview", + "integrations/privacy/osano" + ] }, { "group": "Components", @@ -240,7 +247,9 @@ }, { "group": "Changelog", - "pages": ["changelog/overview"] + "pages": [ + "changelog/overview" + ] } ], "footer": { @@ -324,4 +333,4 @@ "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" } } -} +} \ No newline at end of file