diff --git a/advanced/dashboard/permissions.mdx b/advanced/dashboard/permissions.mdx index d39d099a4..ec0188359 100644 --- a/advanced/dashboard/permissions.mdx +++ b/advanced/dashboard/permissions.mdx @@ -3,14 +3,14 @@ title: 'Editor Permissions' description: 'Allow more members of your team to update your docs' --- -The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same GitHub account that was used while signing up for Mintlify. +The team member who created your initial documentation will have update access to your docs, as long as they push to your documentation repository with the same GitHub account used during Mintlify signup. -If another editor attempts to update the docs while on the free plan, you will see a warning in your git commit check. +If another editor attempts to update the docs while on the free plan, you will see a warning in your GitHub commit check. -In the details of the git check warning, you'll find the link to upgrade your plan. You can also upgrade your plan on the [dashboard](https://dashboard.mintlify.com) to enable unlimited editors to update your docs. Once you upgrade your plan, trigger a manual update or push another change to deploy your updates. +In the details of the GitHub check warning, you'll find a link to upgrade your plan. You can upgrade your plan on the [dashboard](https://dashboard.mintlify.com) to enable unlimited editors to update your documentation. Once you upgrade, trigger a manual update or push another change to deploy your updates. -Learn more about our pricing [here](https://mintlify.com/pricing). +Learn more about our pricing [here](https://mintlify.com/pricing). \ No newline at end of file diff --git a/advanced/dashboard/sso.mdx b/advanced/dashboard/sso.mdx index 4a70acc7a..6517d659d 100644 --- a/advanced/dashboard/sso.mdx +++ b/advanced/dashboard/sso.mdx @@ -3,7 +3,7 @@ title: "Single Sign-On (SSO)" description: "Customize how your team can login to your admin dashboard" --- -Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us! +Use Single Sign-On (SSO) to access your dashboard via SAML and OIDC protocols. For Okta or Google Workspace users, we provide provider-specific documentation for setting up SSO. If you use a different provider, please contact us for assistance! SSO functionality is available on our Enterprise plan. [Contact @@ -19,18 +19,18 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Googl Under `Applications`, click to create a new app integration using SAML 2.0. - Enter the following: - * Single sign-on URL (provided by Mintlify) + Enter the following information: + * Single Sign-On URL (provided by Mintlify) * Audience URI (provided by Mintlify) * Name ID Format: `EmailAddress` * Attribute Statements: - | Name | Name format | Value + | Name | Name Format | Value | ---- | ----------- | ----- | `firstName` | Basic | `user.firstName` | | `lastName` | Basic | `user.lastName` | - Once the application is set up, navigate to the sign-on tab and send us the metadata URL. + Once the application is set up, navigate to the Sign-On tab and send us the metadata URL. We'll enable the connection from our side using this information. @@ -38,15 +38,15 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Googl - Under `Applications`, click to create a new app integration using OIDC. - You should choose the `Web Application` application type. + Under `Applications`, click to create a new app integration using OpenID Connect (OIDC). + Select the `Web Application` application type. - Select the authorization code grant type and enter the Redirect URI provided by Mintlify. + Select the Authorization Code grant type and enter the Redirect URI provided by Mintlify. - Once the application is set up, navigate to the General tab and locate the client ID & client secret. - Please securely provide us with these, along with your Okta instance URL (e.g. `.okta.com`). You can send these via a service like 1Password or SendSafely. + Once the application is set up, navigate to the General tab and locate the Client ID & Client Secret. + Please securely provide us with these credentials, along with your Okta instance URL (e.g., `.okta.com`). You can send these via a secure service like 1Password or SendSafely. @@ -64,31 +64,30 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Googl - Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team. + Copy the provided SSO URL, Entity ID, and X.509 certificate and send them to the Mintlify team. ![](/images/gsuite-saml-metadata.png) - On the Service provider details page, enter the following: + On the Service Provider Details page, enter the following information: * ACS URL (provided by Mintlify) * Entity ID (provided by Mintlify) - * Name ID format: `EMAIL` + * Name ID Format: `EMAIL` * Name ID: `Basic Information > Primary email` ![](/images/gsuite-sp-details.png) - On the next page, enter the following attribute statements: + On the next page, enter the following Attribute Statements: | Google Directory Attribute | App Attribute | | -------------------------- | ------------- | | `First name` | `firstName` | | `Last name` | `lastName` | - Once this step is complete and users are assigned to the application, let our team know and we'll enable SSO for your account! + Once this step is complete and users are assigned to the application, let our team know, and we'll enable SSO for your account! - - + \ No newline at end of file diff --git a/advanced/rest-api/overview.mdx b/advanced/rest-api/overview.mdx index c1f399434..f6530b718 100644 --- a/advanced/rest-api/overview.mdx +++ b/advanced/rest-api/overview.mdx @@ -7,8 +7,8 @@ title: Overview You can leverage the REST API to programmatically trigger an update when desired. - While 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 + While the primary use case will be to trigger updates, we will be adding more and more + functionality to the API over time. Let us know what else you want to see in [our community](https://mintlify.com/community)! @@ -16,27 +16,27 @@ You can leverage the REST API to programmatically trigger an update when desired You can generate an API key through [the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). The API key is -associated with the entire org and can be used across multiple deployments. +associated with the entire organization and can be used across multiple deployments. -## Admin API key +## Admin API Key The Admin API key is used for the majority of the API. It is used to trigger updates via the [Update endpoint](/advanced/rest-api/update/trigger). -## Chat API key +## Chat API Key -The Chat API allows you to embed the AI chat experience grounded in your docs and continually kept up to date into any application of your choosing. +The Chat API allows you to embed the AI chat experience, grounded in your docs and continually kept up to date, into any application of your choosing. Responses include citations so you can point your users to the right places they need to get help. The Chat API token is a public token that can be referenced in your - frontend code whereas the API key is a server-side token that should be kept + frontend code, whereas the API key is a server-side token that should be kept secret. Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use -the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com). +the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com). \ No newline at end of file diff --git a/api-playground/mdx/configuration.mdx b/api-playground/mdx/configuration.mdx index 9ef4eb106..c73e5caba 100644 --- a/api-playground/mdx/configuration.mdx +++ b/api-playground/mdx/configuration.mdx @@ -3,11 +3,11 @@ title: 'MDX Setup' description: 'Generate docs pages for your API endpoints using MDX' --- -Mintlify allows you to define your API endpoints using a combination of `docs.json` configuration, MDX metadata fields, and the `` component. From the defined endpoints, we generate an API playground, request examples, and response examples. +Mintlify allows you to define your API endpoints using a combination of `docs.json` configuration, MDX metadata fields, and the `` component. From the defined endpoints, we generate an API Playground, request examples, and response examples. - In your `docs.json` file, define your base URL and auth method: + In your `docs.json` file, define your base URL and authentication method: ```json "api": { @@ -15,13 +15,13 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js "server": "https://mintlify.com/api", // string array for multiple base URLs "auth": { "method": "key", - "name": "x-api-key" // options: bearer, basic, key. + "name": "x-api-key" // options: bearer, basic, key } } } ``` - If you would not like to show an API playground, you don't need to include auth types. Hide the playground with the following field: + If you do not want to display an API Playground, you don't need to include authentication types. You can hide the playground with the following field: ```json "api": { @@ -31,11 +31,10 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js } ``` - Find a full list of API configurations [here](/settings/global#param-api). + Find a complete list of API configurations [here](/settings/global#param-api). - Each API endpoint page should have a corresponding MDX file. At the top of each file, define: ```md @@ -45,30 +44,28 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js --- ``` - You can specify path parameters by adding the parameter name to the path, wrapped with `{}`: + You can specify path parameters by adding the parameter name to the path, wrapped with curly braces `{}`: ```bash https://api.example.com/v1/endpoint/{userId} ``` - If you have `server` configured in [docs.json](/settings/global), you can use relative paths like `/v1/endpoint`. - - You can also override the globally-defined display mode for the API playground per page by adding `playground` at the top of the MDX file: + You can also override the globally-defined display mode for the API Playground per page by adding the `playground` field at the top of the MDX file: ```md --- title: 'Create new user' api: 'POST https://api.mintlify.com/user' playground: 'none' + --- ``` - - Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs [here](/settings/navigation). + Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your documentation [here](/settings/navigation). - + \ No newline at end of file diff --git a/docs.json b/docs.json index 381cdcce0..faa995b8f 100644 --- a/docs.json +++ b/docs.json @@ -22,7 +22,10 @@ { "group": "Editing", "icon": "pen-paintbrush", - "pages": ["development", "web-editor"] + "pages": [ + "development", + "web-editor" + ] }, "settings/global", { @@ -69,7 +72,8 @@ "icon": "markdown", "pages": [ "api-playground/mdx/configuration", - "api-playground/mdx/authentication" + "api-playground/mdx/authentication", + "api-playground/mdx/configuration" ] }, "api-playground/troubleshooting" @@ -127,13 +131,19 @@ "settings/authentication-personalization/personalization-setup/oauth" ] }, - "settings/authentication-personalization/sending-data" + "settings/authentication-personalization/sending-data", + "settings/authentication-personalization/authentication" ] }, { "group": "Dashboard Access", "icon": "house-lock", - "pages": ["advanced/dashboard/sso", "advanced/dashboard/permissions"] + "pages": [ + "advanced/dashboard/sso", + "advanced/dashboard/permissions", + "advanced/dashboard/permissions", + "advanced/dashboard/sso" + ] }, { "group": "REST API", @@ -153,7 +163,8 @@ "advanced/rest-api/chat/create-topic", "advanced/rest-api/chat/generate-message" ] - } + }, + "advanced/rest-api/overview" ] } ] @@ -205,7 +216,7 @@ "pages": [ "integrations/analytics/overview", "integrations/analytics/amplitude", - "integrations/analytics/clearbit", + "integrations/analytics/clearbit", "integrations/analytics/fathom", "integrations/analytics/google-analytics", "integrations/analytics/google-tag-manager", @@ -251,7 +262,9 @@ "groups": [ { "group": "Changelog", - "pages": ["changelog/overview"] + "pages": [ + "changelog/overview" + ] } ] } @@ -363,4 +376,4 @@ "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" } } -} +} \ No newline at end of file diff --git a/settings/authentication-personalization/authentication.mdx b/settings/authentication-personalization/authentication.mdx index 81c5b8a7e..a32c504a6 100644 --- a/settings/authentication-personalization/authentication.mdx +++ b/settings/authentication-personalization/authentication.mdx @@ -3,23 +3,22 @@ title: "Authentication" description: "Guarantee privacy of your docs by authenticating users" --- -Authentication offers full privacy for all of your -documentation content by requiring users to authenticate before viewing any content, such as: +Authentication offers complete privacy for all your documentation content by requiring users to authenticate before viewing any content, including: - Documentation page content - Images used in documentation pages - Search results - AI chat interactions -You can authenticate users through handshake methods such as: +You can authenticate users through several handshake methods: - [Password](./authentication-setup/password) - [JWT](./authentication-setup/jwt) - [OAuth](./authentication-setup/oauth) -- [Mintlify dashboard](./authentication-setup/mintlify) +- [Mintlify Dashboard](./authentication-setup/mintlify) -Authentication is similar to our [Personalization](./personalization) offering, but with guaranteed privacy. In addition -to securing your documentation content, all features that are available via -Personalization are also available via Authentication. +Authentication is similar to our [Personalization](./personalization) offering but provides guaranteed privacy. In addition +to securing your documentation content, all features available through +Personalization are also accessible via Authentication. -Check out our docs for more info on [choosing Authentication vs Personalization](./authentication-vs-personalization). +For more information about choosing between these options, see our guide on [Authentication vs. Personalization](./authentication-vs-personalization). \ No newline at end of file