diff --git a/ai/contextual-menu.mdx b/ai/contextual-menu.mdx index f888e98c8..08db335a5 100644 --- a/ai/contextual-menu.mdx +++ b/ai/contextual-menu.mdx @@ -7,7 +7,7 @@ keywords: ["AI tools", "ChatGPT", "Claude", "Perplexity", "MCP", "Grok", "cursor import { PreviewButton } from "/snippets/previewbutton.jsx" import IconsRequired from "/snippets/icons-required.mdx"; -The contextual menu provides quick access to AI-optimized content and direct integrations with popular AI tools. When users select the contextual menu on any page, they can copy content as context for AI tools or open conversations in ChatGPT, Claude, Perplexity, Google AI Studio, Grok, Devin, Windsurf, or a custom tool of your choice with your documentation already loaded as context. +The contextual menu provides quick access to AI-optimized content and direct integrations with popular AI tools. When users click the contextual menu on any page, they can copy content as context for AI tools or open it in an AI conversation. Supported tools include ChatGPT, Claude, Perplexity, Google AI Studio, Grok, Devin, Windsurf, and any custom tool you configure. Pair the contextual menu with your hosted [`skill.md`](/ai/skillmd) file and [MCP server](/ai/model-context-protocol) so that users can install your product's full capabilities into their AI tools, not just the page they are reading. diff --git a/ai/mintlify-mcp.mdx b/ai/mintlify-mcp.mdx index f27c1cd31..740670544 100644 --- a/ai/mintlify-mcp.mdx +++ b/ai/mintlify-mcp.mdx @@ -32,14 +32,14 @@ Connecting requires an interactive OAuth login against your Mintlify account. Th 1. Navigate to the [Connectors](https://claude.ai/settings/connectors) page in the Claude settings. - 2. Select **Add custom connector**. + 2. Click **Add custom connector**. 3. Add the connector - Name: Mintlify MCP - URL:  `https://mcp.mintlify.com` - 4. Select **Add** and complete the OAuth login. + 4. Click **Add** and complete the OAuth login. - Select the attachments button (the plus icon), then select your Mintlify MCP server. Claude can now call the Mintlify MCP tools while answering your prompt. + Click the attachments button (the plus icon), then select your Mintlify MCP server. Claude can now call the Mintlify MCP tools while answering your prompt. @@ -54,7 +54,7 @@ Connecting requires an interactive OAuth login against your Mintlify account. Th 1. Open the command palette with Command \+ Shift \+ P (Ctrl \+ Shift \+ P on Windows). - 2. Search for **Open MCP settings** and select **Add custom MCP**. + 2. Search for **Open MCP settings** and click **Add custom MCP**. 3. In `mcp.json`, add the Mintlify MCP: ```json diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index 7a034033d..13d956208 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -154,7 +154,7 @@ Client credentials authenticate against the `/authed/mcp` endpoint and return al 1. Navigate to the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard. - 2. In the **Client Credentials** section, select **Create credential**. + 2. In the **Client Credentials** section, click **Create credential**. 3. Enter a label for the credential to identify its purpose. 4. Copy the **client ID** and **client secret**. The client secret is only shown once. You cannot retrieve it later. @@ -306,10 +306,10 @@ These are some of the ways you can help your users connect to your MCP server: Create a guide for your users that includes your MCP server URL and the steps to connect it to Claude. 1. Navigate to the [Connectors](https://claude.ai/settings/connectors) page in the Claude settings. - 2. Select **Add custom connector**. + 2. Click **Add custom connector**. 3. Add your MCP server name and URL. - 4. Select **Add**. - 5. When using Claude, select the attachments button (the plus icon). + 4. Click **Add**. + 5. When using Claude, click the attachments button (the plus icon). 6. Select your MCP server. @@ -342,7 +342,7 @@ See the [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-co 1. Use Command + Shift + P (Ctrl + Shift + P on Windows) to open the command palette. 2. Search for "Open MCP settings". - 3. Select **Add custom MCP**. This opens the `mcp.json` file. + 3. Click **Add custom MCP**. This opens the `mcp.json` file. 4. In `mcp.json`, configure your server: ```json @@ -402,14 +402,14 @@ To use the Mintlify MCP server with Claude: 1. Navigate to the [Connectors](https://claude.ai/settings/connectors) page in the Claude settings. - 2. Select **Add custom connector**. + 2. Click **Add custom connector**. 3. Add the Mintlify MCP server: - Name: `Mintlify` - URL: `https://mintlify.com/docs/mcp` - 4. Select **Add**. + 4. Click **Add**. - 1. When using Claude, select the attachments button (the plus icon). + 1. When using Claude, click the attachments button (the plus icon). 2. Select the Mintlify MCP server. 3. Ask Claude a question about Mintlify. @@ -444,7 +444,7 @@ To connect the Mintlify MCP server to Cursor, click the **Install in Cursor** bu 1. Use Command + Shift + P (Ctrl + Shift + P on Windows) to open the command palette. 2. Search for "Open MCP settings". - 3. Select **Add custom MCP**. This opens the `mcp.json` file. + 3. Click **Add custom MCP**. This opens the `mcp.json` file. In `mcp.json`, add: diff --git a/api-playground/managing-page-visibility.mdx b/api-playground/managing-page-visibility.mdx index 3d1ea6c1d..e114313ec 100644 --- a/api-playground/managing-page-visibility.mdx +++ b/api-playground/managing-page-visibility.mdx @@ -4,7 +4,7 @@ description: "Control which API endpoints appear in your documentation navigatio keywords: ["x-hidden", "x-excluded", "hide endpoints", "page visibility", "internal endpoints"] --- -For internal-only endpoints, deprecated operations, beta features, or endpoints that should be accessible via direct URL but not discoverable through site navigation, you can control which OpenAPI operations get published as documentation pages and their visibility in navigation. +You can control which OpenAPI operations get published as documentation pages and their visibility in navigation. This is useful for internal-only endpoints, deprecated operations, beta features, or endpoints that should be accessible via direct URL but not discoverable through site navigation. If your pages are autogenerated from an OpenAPI document, manage page visibility with the `x-hidden` and `x-excluded` extensions. diff --git a/assistant/use.mdx b/assistant/use.mdx index 5423353f5..dbc671d51 100644 --- a/assistant/use.mdx +++ b/assistant/use.mdx @@ -81,7 +81,7 @@ https://yourdocs.mintlify.app/quickstart?assistant=How%20do%20I%20get%20started% ## Highlight text -Highlight text on a page and click the **Add to assistant** pop up button to open the assistant chat panel and add the highlighted text as context. You can add multiple text snippets or code blocks to the assistant's context. +Highlight text on a page and click the **Add to assistant** button to open the assistant chat panel and add the highlighted text as context. You can add multiple text snippets or code blocks to the assistant's context. The Add to assistant button above highlighted text in light mode. diff --git a/contact-support.mdx b/contact-support.mdx index ed1261db9..d84de71d7 100644 --- a/contact-support.mdx +++ b/contact-support.mdx @@ -13,7 +13,7 @@ Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tut ## Message support -Send us a message from your [dashboard](https://dashboard.mintlify.com/). Select **Support** in the sidebar. +Send us a message from your [dashboard](https://dashboard.mintlify.com/). Click **Support** in the sidebar. Contact support panel open in the dashboard. diff --git a/dashboard/permissions.mdx b/dashboard/permissions.mdx index d6013b9a9..84bf4ec56 100644 --- a/dashboard/permissions.mdx +++ b/dashboard/permissions.mdx @@ -6,4 +6,4 @@ keywords: ["editor access", "permissions", "team", "seats", "deployment"] People with the editor or admin [role](/dashboard/roles) can use the web editor, trigger deployments, and manage integrations from your dashboard. When an editor or admin publishes through the web editor or merges a pull request into your documentation repository, the changes deploy to your live site automatically. -Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard. +Anyone with access to your documentation repository can contribute by pushing changes. However, their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard. diff --git a/dashboard/sso.mdx b/dashboard/sso.mdx index b0a52596e..62702b708 100644 --- a/dashboard/sso.mdx +++ b/dashboard/sso.mdx @@ -54,18 +54,18 @@ Enterprise admins can configure SAML SSO for Okta or Microsoft Entra directly fr 1. In Microsoft Entra, navigate to **Enterprise applications**. - 2. Select **New application**. - 3. Select **Create your own application**. + 2. Click **New application**. + 3. Click **Create your own application**. 4. Select "Integrate any other application you don't find in the gallery (Non-gallery)." 1. In Microsoft Entra, navigate to **Single Sign-On**. - 2. Select **SAML**. + 2. Click **SAML**. 3. Under **Basic SAML Configuration**, enter the following: * **Identifier (Entity ID)**: the Audience URI from Mintlify * **Reply URL (Assertion Consumer Service URL)**: the Single sign on URL from Mintlify - Leave the other values blank and select **Save**. + Leave the other values blank and click **Save**. 1. In Microsoft Entra, navigate to **Attributes & Claims**. @@ -143,7 +143,7 @@ The resulting SAML assertion should include an `AttributeStatement`. In your Microsoft Entra enterprise application: 1. Navigate to **Single Sign-On** > **Attributes & Claims**. - 2. Select **Add a group claim**. + 2. Click **Add a group claim**. 3. Select which groups to include (all groups or specific ones). 4. Under **Advanced options**, check **Customize the name of the group claim** and set the name to `groups`. @@ -168,7 +168,7 @@ For providers other than Microsoft Entra or Okta SAML, [contact us](mailto:suppo 1. In Google Workspace, navigate to **Web and mobile apps**. - 2. Select **Add custom SAML app** from the **Add app** dropdown. + 2. Click **Add custom SAML app** in the **Add app** dropdown. ![Screenshot of the Google Workspace SAML application creation page with the "Add custom SAML app" menu item highlighted](/images/gsuite-add-custom-saml-app.png) diff --git a/deploy/cloudflare-firewall-troubleshooting.mdx b/deploy/cloudflare-firewall-troubleshooting.mdx index cefc14aed..0d5389549 100644 --- a/deploy/cloudflare-firewall-troubleshooting.mdx +++ b/deploy/cloudflare-firewall-troubleshooting.mdx @@ -30,7 +30,7 @@ Create a Cloudflare firewall rule to exempt Mintlify assets from security checks 1. Log in to your [Cloudflare dashboard](https://dash.cloudflare.com/) 2. Select your domain 3. Navigate to **Security > WAF** -4. Select **Create rule** +4. Click **Create rule** 5. Configure the rule with these settings: **Rule name:** Allow Mintlify assets @@ -50,7 +50,7 @@ Create a Cloudflare firewall rule to exempt Mintlify assets from security checks - Select: `All remaining custom rules`, `Managed rules`, and `Super Bot Fight Mode` 6. Enable **Log** to track matched requests -7. Select **Deploy** +7. Click **Deploy** ### Verify the rule diff --git a/deploy/cloudflare.mdx b/deploy/cloudflare.mdx index 26c80b964..e20c40365 100644 --- a/deploy/cloudflare.mdx +++ b/deploy/cloudflare.mdx @@ -42,7 +42,7 @@ Ensure that the `HOST` header is correctly forwarded in your Worker configuratio ### Configure routing -In your Cloudflare dashboard, select **Edit Code** and add the following script into your Worker's code. See the [Cloudflare documentation](https://developers.cloudflare.com/workers-ai/get-started/dashboard/#development) for more information on editing a Worker. +In your Cloudflare dashboard, click **Edit Code** and add the following script into your Worker's code. See the [Cloudflare documentation](https://developers.cloudflare.com/workers-ai/get-started/dashboard/#development) for more information on editing a Worker. Replace `[SUBDOMAIN]` with your unique subdomain, `[YOUR_DOMAIN]` with your website's base URL, and `/docs` with your desired subpath if different. @@ -88,7 +88,7 @@ async function handleRequest(request) { } ``` -Select **Deploy** and wait for the changes to propagate. +Click **Deploy** and wait for the changes to propagate. @@ -128,7 +128,7 @@ If you use Webflow to host your main site and want to serve Mintlify docs at `/d 1. In Webflow, set up a landing page for your main site like `landing.yoursite.com`. This is the page that visitors see when they visit your site. 2. Deploy your main site to the landing page. This ensures that your main site remains accessible while you configure the Worker. 3. To avoid conflicts, update any absolute URLs in your main site to be relative. -4. In Cloudflare, select **Edit Code** and add the following script into your Worker's code. +4. In Cloudflare, click **Edit Code** and add the following script into your Worker's code. Replace `[SUBDOMAIN]` with your unique subdomain, `[YOUR_DOMAIN]` with your website's base URL, `[LANDING_DOMAIN]` with your landing page URL, and `/docs` with your desired subpath if different. @@ -177,6 +177,6 @@ If you use Webflow to host your main site and want to serve Mintlify docs at `/d } } ``` -5. Select **Deploy** and wait for the changes to propagate. +5. Click **Deploy** and wait for the changes to propagate. diff --git a/deploy/csp-configuration.mdx b/deploy/csp-configuration.mdx index ec3d1031c..0ee0f384b 100644 --- a/deploy/csp-configuration.mdx +++ b/deploy/csp-configuration.mdx @@ -76,7 +76,7 @@ Most reverse proxies support adding custom headers. Create a Response Header Transform Rule: 1. In your Cloudflare dashboard, go to **Rules > Overview**. -2. Select **Create rule > Response Header Transform Rule**. +2. Click **Create rule > Response Header Transform Rule**. 3. Configure the rule: - **Modify response header**: Set static - **Header name**: `Content-Security-Policy` diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index 11f3293d8..bfde5e7f8 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -18,7 +18,7 @@ If you have the GitHub App installed, but changes are still not deploying, manua Check that your latest commit appears in your docs repository and did not encounter any errors. - Go to your [dashboard](https://dashboard.mintlify.com) and select the deploy button. + Go to your [dashboard](https://dashboard.mintlify.com) and click the deploy button. The manual update button emphasized with an orange rectangle. The manual update button emphasized with an orange rectangle. diff --git a/deploy/export.mdx b/deploy/export.mdx index 414ca4025..738e48ae4 100644 --- a/deploy/export.mdx +++ b/deploy/export.mdx @@ -70,7 +70,7 @@ Share the zip file with anyone who has Node.js installed. To view the docs: 3. The docs open in your default browser at `http://localhost:3000`. - macOS may block the file because it was downloaded from the internet. If you see a security warning, go to **System Settings > Privacy & Security** and select **Open Anyway**. See [Apple's guide to overriding security settings](https://support.apple.com/guide/mac-help/mh40617/mac) for details. + macOS may block the file because it was downloaded from the internet. If you see a security warning, go to **System Settings > Privacy & Security** and click **Open Anyway**. See [Apple's guide to overriding security settings](https://support.apple.com/guide/mac-help/mh40617/mac) for details. @@ -79,7 +79,7 @@ Share the zip file with anyone who has Node.js installed. To view the docs: 3. The docs open in your default browser at `http://localhost:3000`. - Windows may show a "Windows protected your PC" warning because the file was downloaded from the internet. Select **More info**, then select **Run anyway**. + Windows may show a "Windows protected your PC" warning because the file was downloaded from the internet. Click **More info**, then click **Run anyway**. diff --git a/deploy/github.mdx b/deploy/github.mdx index 9fa5547dc..91e84795b 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -135,8 +135,8 @@ If you encounter problems with the GitHub app, resetting the connection can solv - 1. In GitHub, go to [installations](https://github.com/settings/installations) and select **Configure** next to the Mintlify app. Scroll down and select **Uninstall**. - 2. Go to [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) and select **Revoke** next to the Mintlify app. + 1. In GitHub, go to [installations](https://github.com/settings/installations) and click **Configure** next to the Mintlify app. Scroll down and click **Uninstall**. + 2. Go to [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) and click **Revoke** next to the Mintlify app. 1. In your Mintlify dashboard, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and install the GitHub app. diff --git a/deploy/gitlab.mdx b/deploy/gitlab.mdx index bfdac4c38..7d8d33c53 100644 --- a/deploy/gitlab.mdx +++ b/deploy/gitlab.mdx @@ -37,7 +37,7 @@ When you open [Git Settings](https://dashboard.mintlify.com/settings/deployment/ - Navigate to **Settings** > **Access Tokens** and select **Add new token**. + Navigate to **Settings** > **Access Tokens** and click **Add new token**. Configure the token with these settings: - **Name**: Mintlify diff --git a/deploy/monorepo.mdx b/deploy/monorepo.mdx index 109c2869c..493fe870b 100644 --- a/deploy/monorepo.mdx +++ b/deploy/monorepo.mdx @@ -48,11 +48,11 @@ Navigate to [Git Settings](https://dashboard.mintlify.com/settings/deployment/gi -1. Select the **Set up as monorepo** toggle button. +1. Click the **Set up as monorepo** toggle. 2. Enter the relative path to your docs directory. For example, if your docs are in the `docs` directory, enter `/docs`. Do not include a trailing slash in the path. -3. Select **Save changes**. +3. Click **Save changes**. diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 0d87b6879..3474d78a9 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -34,10 +34,10 @@ When you create a pull request, the Mintlify bot automatically adds a link to vi You can manually create a preview for any branch. 1. Go to your [dashboard](https://dashboard.mintlify.com/). -2. Select **Previews**. -3. Select **Create custom preview**. +2. Click **Previews**. +3. Click **Create custom preview**. 4. Enter the name of the branch you want to preview. -5. Select **Create preview**. +5. Click **Create preview**. ### API @@ -47,8 +47,8 @@ You can also create preview deployments programmatically using the [Trigger prev Redeploy a preview to refresh content or retry after a failed deployment. -1. Select the preview from your [dashboard](https://dashboard.mintlify.com/). -2. Select **Redeploy**. +1. Click the preview from your [dashboard](https://dashboard.mintlify.com/). +2. Click **Redeploy**. The Previews menu with the deploy button emphasized by an orange rectangle. @@ -95,15 +95,15 @@ Restrict preview access to authenticated members of your Mintlify organization. Password-protect a specific preview to share it with external reviewers without adding them to your Mintlify organization. This option is available when creating a manual preview and is not shown when organization authentication is already enabled for your deployment. 1. Go to your [dashboard](https://dashboard.mintlify.com/). -2. Select **Previews**. -3. Select **Create custom preview**. +2. Click **Previews**. +3. Click **Create custom preview**. 4. Enter the name of the branch you want to preview. 5. Toggle **Make private** on and enter a password. Passwords must be at least 8 characters. The Create a custom preview modal with the Make private toggle enabled and a password field. The Create a custom preview modal with the Make private toggle enabled and a password field. -6. Select **Create preview**. +6. Click **Create preview**. ## Troubleshooting preview deployments diff --git a/deploy/reverse-proxy.mdx b/deploy/reverse-proxy.mdx index 3c8756fc3..2c3342d81 100644 --- a/deploy/reverse-proxy.mdx +++ b/deploy/reverse-proxy.mdx @@ -23,7 +23,7 @@ Before configuring your reverse proxy: 1. Navigate to [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard. 2. Enable the **Host at `/docs`** toggle. -3. Enter your domain and select **Add domain**. +3. Enter your domain and click **Add domain**. When you enable **Host at `/docs`**, your canonical docs URL becomes `.mintlify.dev`. Cache invalidation stops on `mintlify.app`, and you must proxy to `mintlify.dev` for updates to appear. diff --git a/deploy/route53-cloudfront.mdx b/deploy/route53-cloudfront.mdx index cd43139c7..d63db1249 100644 --- a/deploy/route53-cloudfront.mdx +++ b/deploy/route53-cloudfront.mdx @@ -30,7 +30,7 @@ All Behaviors must have an **origin request policy** of `AllViewerExceptHostHead ## Create CloudFront distribution 1. Navigate to [CloudFront](https://aws.amazon.com/cloudfront) inside the AWS console. -2. Select **Create distribution**. +2. Click **Create distribution**. ![CloudFront Distributions page with the "Create distribution" button emphasized.](/images/cloudfront/create-distribution.png) @@ -49,7 +49,7 @@ All Behaviors must have an **origin request policy** of `AllViewerExceptHostHead 5. The remaining settings should be default. -6. Select **Create distribution**. +6. Click **Create distribution**. ## Add default origin @@ -92,7 +92,7 @@ Behaviors in CloudFront enable control over the subpath logic. At a high level, ![CloudFront "Behaviors" tab highlighted.](/images/cloudfront/behaviors.png) -2. Select the **Create behavior** button and create the following behaviors. +2. Click the **Create behavior** button and create the following behaviors. ### `/.well-known/*` @@ -152,7 +152,7 @@ Lastly, we're going to edit the `Default (*)` behavior. ![CloudFront "Edit behavior" page with the "Origin and origin groups" input field highlighted.](/images/cloudfront/default-behavior-2.png) -2. Select **Save changes**. +2. Click **Save changes**. ### Check behaviors are set up correctly @@ -184,7 +184,7 @@ Now, we're going to bring the capabilities of the CloudFront distribution into y 1. Navigate to [Route53](https://aws.amazon.com/route53) inside the AWS console. 2. Navigate to the "Hosted zone" for your primary domain. -3. Select **Create record**. +3. Click **Create record**. ![Route 53 "Records" page with the "Create record" button emphasized.](/images/cloudfront/route53-create-record.png) @@ -196,7 +196,7 @@ Now, we're going to bring the capabilities of the CloudFront distribution into y ![Route 53 "Create record" page with the "Alias" toggle and the "Route traffic to" menu highlighted.](/images/cloudfront/create-record-alias.png) -5. Select **Create records**. +5. Click **Create records**. You may need to remove the existing A record if one currently exists. diff --git a/deploy/vercel.mdx b/deploy/vercel.mdx index 426ca6618..f0d4ea200 100644 --- a/deploy/vercel.mdx +++ b/deploy/vercel.mdx @@ -22,13 +22,13 @@ Rewrites map incoming requests to different destinations without changing the UR ### Host at `/docs` subpath 1. Navigate to [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard. -2. Click the **Host at `/docs`** toggle to the on position. +2. Set the **Host at `/docs`** toggle to on. Screenshot of the Custom domain setup page. The Host at `/docs` toggle is on and highlighted by an orange rectangle. Screenshot of the Custom domain setup page. The Host at `/docs` toggle is on and highlighted by an orange rectangle. 3. Enter your domain. -4. Select **Add domain**. +4. Click **Add domain**. 5. Add the following rewrites to your `vercel.json` file. Replace `[subdomain]` with your subdomain, which appears at the end of your dashboard URL. For example, `dashboard.mintlify.com/your-organization/your-subdomain` has a domain identifier of `your-subdomain`. ```json diff --git a/editor/branching-and-publishing.mdx b/editor/branching-and-publishing.mdx index 81a4294e0..b8b16c15a 100644 --- a/editor/branching-and-publishing.mdx +++ b/editor/branching-and-publishing.mdx @@ -12,7 +12,7 @@ What happens when you publish depends on two things: **which branch you're on** **Saving** happens automatically. Mintlify stores your edits on its servers and persists them across browser tabs, devices, and network interruptions. -**Publishing** commits your changes to your Git repository. Click the **Publish** button in the toolbar to open the publish menu, save your changes as a Git commit, and create a pull request. +**Publishing** commits your changes to your Git repository. Click **Publish** in the toolbar to open the publish menu, save your changes as a Git commit, and create a pull request. The editor tracks the following as pending changes: diff --git a/editor/pages.mdx b/editor/pages.mdx index 19cb35d70..4bb67a373 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -71,7 +71,7 @@ When editing a code block in visual mode, you can: ## Review changes before publishing -Open the publish menu and click any changed file to enter diff view. The editor highlights differences between your draft and the last published version. If you're in visual mode, you see a visual diff; if you're in Markdown mode, you see a Markdown diff. +Open the publish menu and click any changed file to enter diff view. The editor highlights differences between your draft and the last published version. If you're in visual mode, you see a visual diff. If you're in Markdown mode, you see a Markdown diff. Diff view is read-only. Click the button next to the mode toggle to return to editing. diff --git a/guides/automate-agent.mdx b/guides/automate-agent.mdx index eab9d4c2f..b2ddbd1de 100644 --- a/guides/automate-agent.mdx +++ b/guides/automate-agent.mdx @@ -51,7 +51,7 @@ Install the Mintlify app on your code repository so the agent can fetch context ### Get your admin API key 1. Navigate to the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard. -2. Select **Create Admin API Key**. +2. Click **Create Admin API Key**. 3. Copy the key and save it securely. ## Build the GitHub Actions workflow @@ -211,7 +211,7 @@ Install the Mintlify app on your code repository so the agent can fetch context ### Get your admin API key 1. Navigate to the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard. -2. Select **Create Admin API Key**. +2. Click **Create Admin API Key**. 3. Copy the key and save it securely. ### Get your GitHub personal access token diff --git a/guides/branches.mdx b/guides/branches.mdx index 8e5eec805..e33fb0dd4 100644 --- a/guides/branches.mdx +++ b/guides/branches.mdx @@ -80,7 +80,7 @@ Use clear, descriptive names that explain the purpose of a branch. - Select the **Save as commit** button in the top-right of the editor toolbar. This creates a commit and pushes your work to your branch automatically. + Click the **Save as commit** button in the top-right of the editor toolbar. This creates a commit and pushes your work to your branch automatically. Stage, commit, and push your changes. diff --git a/guides/custom-frontend.mdx b/guides/custom-frontend.mdx index 5be7c5ba5..ad855fba2 100644 --- a/guides/custom-frontend.mdx +++ b/guides/custom-frontend.mdx @@ -7,7 +7,7 @@ keywords: ["Astro", "headless", "self-hosted", "custom", "headless docs", "headl Mintlify's headless mode lets you control how your documentation looks and behaves while using Mintlify to manage your content. Instead of using Mintlify's hosted frontend, you can build your own custom frontend with [Astro](https://astro.build) and render your MDX content and `docs.json` configuration however you want. -This headless approach is useful when you need full control over your documentation's design, layout, or behavior to match an existing design system or embed documentation into a larger site while still using Mintlify for publishing, search, MDX components, and AI features. +This headless approach is useful when you need full control over your documentation's design, layout, or behavior—for example, to match an existing design system or embed documentation into a larger site. You still get Mintlify's publishing, search, MDX components, and AI features. The `@mintlify/astro` integration reads your `docs.json` config and MDX content at build time, then processes everything into a format that Astro can render. Build your own layouts, components, and styles on top of it. diff --git a/guides/help-center.mdx b/guides/help-center.mdx index 65a8141a2..db2f710f0 100644 --- a/guides/help-center.mdx +++ b/guides/help-center.mdx @@ -132,7 +132,7 @@ description: "Troubleshoot common problems signing in to your account" If you forgot your password, request a reset link from the login page. 1. Go to the login page. -2. Select **Forgot password**. +2. Click **Forgot password**. 3. Enter your email address. 4. Check your inbox for the reset link. diff --git a/integrations/sdks/stainless.mdx b/integrations/sdks/stainless.mdx index 3f495fbf9..f38c9b28e 100644 --- a/integrations/sdks/stainless.mdx +++ b/integrations/sdks/stainless.mdx @@ -18,8 +18,8 @@ boost: 3 In your Stainless project: - 1. Select the **Release** tab. - 2. Select **Setup OpenAPI publishing**. + 1. Click the **Release** tab. + 2. Click **Setup OpenAPI publishing**. 3. Copy the URL to your publicly accessible OpenAPI spec. ` block with instructions Agents post feedback to the endpoint with the page path and feedback text. The feedback appears in the dashboard alongside human feedback. -The feedback endpoint is always available at `https://your-domain.com/feedback` as a `POST` request, even if you don't add the instructions to the Markdown export, so you can prompt agents to submit feedback manually by posting to the endpoint. +The feedback endpoint is always available at `https://your-domain.com/feedback` as a `POST` request, even if you don't add the instructions to the Markdown export. You can prompt agents to submit feedback manually by posting to the endpoint. ### Enable agent feedback diff --git a/optimize/pdf-exports.mdx b/optimize/pdf-exports.mdx index 63c235254..efba1c2e1 100644 --- a/optimize/pdf-exports.mdx +++ b/optimize/pdf-exports.mdx @@ -24,12 +24,12 @@ PDF exports are not supported for documentation sites that use authentication. ## Export a PDF 1. Navigate to the [General](https://dashboard.mintlify.com/settings/deployment/general) page in the Project Settings section of your dashboard. -2. Select the **Export all content** button. +2. Click the **Export all content** button. 3. Optionally, customize the export options: - **Page format**: Choose the page size of the PDF. - **Scale percentage**: Adjust the scale of the PDF. - **Include footer**: Include a footer with the page number and total pages. -4. Select **Export** to start the export process. +4. Click **Export** to start the export process. 5. Once the export is complete, you receive an email with a download link. 6. Click the download link to download the PDF file. diff --git a/quickstart.mdx b/quickstart.mdx index 083392251..8e2cb6b5e 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -139,7 +139,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa - Click the **Publish** button in the top-right of the web editor toolbar. + Click **Publish** in the top-right of the web editor toolbar. On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live. diff --git a/workflows/enable.mdx b/workflows/enable.mdx index 6869cbbf7..920e90c7a 100644 --- a/workflows/enable.mdx +++ b/workflows/enable.mdx @@ -39,7 +39,7 @@ For GitHub repositories, you must install the Mintlify GitHub App on each reposi Each workflow has a default mode for how it makes updates, either by directly updating your content repository or by opening a pull request. -If you want to require reviews before a workflow updates your content, select **Require review**. +If you want to require reviews before a workflow updates your content, click **Require review**. For GitHub repositories, automatic updates require the Mintlify GitHub App to have bypass permissions on every ruleset targeting your deploy branch, including organization-level and repository-level rulesets. See [Configure automerge](/guides/configure-automerge) for setup instructions.