diff --git a/ai/contextual-menu.mdx b/ai/contextual-menu.mdx index f888e98c8..352d0e6bd 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 select 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/model-context-protocol.mdx b/ai/model-context-protocol.mdx index 9381b3216..c160ffd89 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -97,7 +97,7 @@ By default, your MCP server is only available for localhost tools. To allow web- 1. Navigate to the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard. - 2. Click the **Enable MCP Server** toggle. + 2. Select the **Enable MCP Server** toggle. Add the redirect domains for the AI tools you want to grant your users access to. Your users' AI tools cannot complete authentication unless their redirect domain is on this list. Common redirect domains include `claude.ai` and `vscode.dev/redirect`. @@ -399,7 +399,7 @@ See the [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-co Install in Cursor -To connect the Mintlify MCP server to Cursor, click the **Install in Cursor** button. Or to manually connect the MCP server, follow these steps: +To connect the Mintlify MCP server to Cursor, select the **Install in Cursor** button. Or to manually connect the MCP server, follow these steps: diff --git a/api-playground/managing-page-visibility.mdx b/api-playground/managing-page-visibility.mdx index c47cd6b0b..735871adf 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..48290b372 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 select 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. @@ -90,7 +90,7 @@ Highlight text on a page and click the **Add to assistant** pop up button to ope ## Code blocks -Click the **Ask AI** button in a code block to open the assistant chat panel and add the code block as context. You can add multiple code blocks or text snippets to the assistant's context. +Select the **Ask AI** button in a code block to open the assistant chat panel and add the code block as context. You can add multiple code blocks or text snippets to the assistant's context. The Ask AI button in a code block in light mode. 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/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 0d87b6879..bdeab6049 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -64,10 +64,10 @@ The preview widget appears on preview deployments to help you navigate and revie Preview widget expanded to show list of changed files. -1. Click the widget to show all added, modified, or removed files in the preview. -1. Click a file to view the changes on the corresponding page. +1. Select the widget to show all added, modified, or removed files in the preview. +1. Select a file to view the changes on the corresponding page. 1. Use the search bar to filter the list of changed files. -1. Hover over a file and click the **Open in editor** icon to edit the file directly in the web editor. +1. Hover over a file and select the **Open in editor** icon to edit the file directly in the web editor. The widget only appears on preview deployments, not on your live site or local previews. @@ -80,7 +80,7 @@ By default, preview deployments are publicly accessible to anyone with the URL. Restrict preview access to authenticated members of your Mintlify organization. 1. Navigate to the **Previews** section in the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard. -2. Click the **Preview authentication** toggle to enable or disable preview authentication. +2. Select the **Preview authentication** toggle to enable or disable preview authentication. The preview authentication toggle in the Add-ons page The preview authentication toggle in the Add-ons page @@ -109,7 +109,7 @@ Password-protect a specific preview to share it with external reviewers without If your preview deployment fails, try these troubleshooting steps. -- **View the build logs**: In your [dashboard](https://dashboard.mintlify.com/), go to **Previews** and click the failed preview. The deployment logs show errors that caused failures. +- **View the build logs**: In your [dashboard](https://dashboard.mintlify.com/), go to **Previews** and select the failed preview. The deployment logs show errors that caused failures. - **Check your configuration**: - Invalid `docs.json` syntax - Missing or incorrect file paths referenced in your navigation diff --git a/deploy/vercel.mdx b/deploy/vercel.mdx index 9cf909dc2..817c3fa33 100644 --- a/deploy/vercel.mdx +++ b/deploy/vercel.mdx @@ -21,7 +21,7 @@ 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. diff --git a/editor/branching-and-publishing.mdx b/editor/branching-and-publishing.mdx index ef87ff7a8..5b5d637ad 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. Your edits are stored on Mintlify's servers and persist 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. Select **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: @@ -24,7 +24,7 @@ The editor tracks the following as pending changes: ## What happens when you publish -The actions available when you click the publish button depend on your current branch and whether it has branch protection rules that require pull requests. +The actions available when you select the publish button depend on your current branch and whether it has branch protection rules that require pull requests. | Branch type | Branch protection | Available actions | |-------------|-------------------|-------------------| @@ -54,10 +54,10 @@ If there are no pending changes, the publish and save actions are disabled. ### Create a branch -1. Click the branch name in the editor toolbar. -1. Click **Create new branch**. +1. Select the branch name in the editor toolbar. +1. Select **Create new branch**. 1. If you have pending changes, choose whether to bring them to the new branch or leave them on the current branch. -1. Enter a name and click **Create branch**. +1. Enter a name and select **Create branch**. Use descriptive branch names so you can easily identify them and other people understand what each branch is for. @@ -65,16 +65,16 @@ If there are no pending changes, the publish and save actions are disabled. ### Switch branches -1. Click the branch name in the toolbar. +1. Select the branch name in the toolbar. 1. Search for or scroll to the branch you want. -1. Click the branch to switch to it. +1. Select the branch to switch to it. Switching branches while you have unpublished changes will prompt you to bring those changes to the new branch or leave them behind. Changes left behind remain on your original branch. - To copy a branch name, hover over the branch in the dropdown and click the copy icon. This is useful when sharing the branch with teammates or referencing it in a pull request. + To copy a branch name, hover over the branch in the dropdown and select the copy icon. This is useful when sharing the branch with teammates or referencing it in a pull request. ## Preview your changes @@ -83,8 +83,8 @@ Every time you save changes to a feature branch, Mintlify builds a preview deplo ### Access and share a preview -1. Click **Publish** in the editor toolbar. -1. In the publish menu, click the preview URL. The URL format is `organization-branch-name.mintlify.app`. +1. Select **Publish** in the editor toolbar. +1. In the publish menu, select the preview URL. The URL format is `organization-branch-name.mintlify.app`. Preview URL emphasized in the publish menu. Preview URL emphasized in the publish menu. @@ -116,9 +116,9 @@ When a pull request is open for the current branch, the publish menu shows its r - **Changes requested**: A reviewer has requested changes before the pull request can merge. - **Awaiting review**: The pull request is waiting for a reviewer. -Click **View request** to open the pull request in your Git provider. +Select **View request** to open the pull request in your Git provider. -When the pull request is approved, click **Merge and publish** to merge and deploy directly from the editor. The editor switches to your deployment branch after merging. +When the pull request is approved, select **Merge and publish** to merge and deploy directly from the editor. The editor switches to your deployment branch after merging. Configure branch protection rules in your Git provider to require pull requests. See [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) in the GitHub docs or [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) in the GitLab docs. @@ -126,7 +126,7 @@ When the pull request is approved, click **Merge and publish** to merge and depl ### Review changes before merging -Click any changed file in the publish menu to open it in diff view and compare your branch against the published version. Files that can't display a diff, such as images or deleted files, appear in the list but aren't clickable. +Select any changed file in the publish menu to open it in diff view and compare your branch against the published version. Files that can't display a diff, such as images or deleted files, appear in the list but aren't selectable. ### Simultaneous publishing diff --git a/editor/live-preview.mdx b/editor/live-preview.mdx index d97bb0f28..0fb885c96 100644 --- a/editor/live-preview.mdx +++ b/editor/live-preview.mdx @@ -8,7 +8,7 @@ Preview your site while you edit. Live previews render pages exactly as they loo ## Open live preview -Click the live preview button in the toolbar to open a live preview in a new tab. +Select the live preview button in the toolbar to open a live preview in a new tab. plus button next to that element. +Select **Add new** at the bottom of the navigation tree to add a new element at the root level. To add an element nested inside another, select the plus button next to that element. -After creating an element, drag and drop it to reorder or nest it. Hover over an element and click the gear icon to configure its properties. +After creating an element, drag and drop it to reorder or nest it. Hover over an element and select the gear icon to configure its properties. Right-click a **page** to open its settings or delete it. @@ -36,7 +36,7 @@ Choose the right structure for your content: ## Configure elements -Hover over any navigation element and click the gear icon to set: +Hover over any navigation element and select the gear icon to set: - **Title**: The label shown in the sidebar. - **Icon**: A visual marker next to the label. diff --git a/editor/pages.mdx b/editor/pages.mdx index 5427829f5..717dac021 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -6,7 +6,7 @@ keywords: ["editor", "content", "pages", "files", "create", "edit", "media", "im ## Navigate files -Browse pages in the **Navigation** tab of the left panel. Click a page to open it. Click the search icon or press Cmd + K (macOS) or Ctrl + K (Windows) to search by filename or page content. +Browse pages in the **Navigation** tab of the left panel. Select a page to open it. Select the search icon or press Cmd + K (macOS) or Ctrl + K (Windows) to search by filename or page content. API specification files (OpenAPI and AsyncAPI) are read-only in the web editor. To update a spec file, edit it in your preferred code editor and push the changes to your documentation repository. @@ -14,8 +14,8 @@ Browse pages in the **Navigation** tab of the left panel. Click a page to open i ## Create new pages -1. Click the plus button in the navigation element where you want to add a page. -1. Click **Add a page**. +1. Select the plus button in the navigation element where you want to add a page. +1. Select **Add a page**. 1. Enter a filename. The editor adds the `.mdx` extension automatically. ## Edit content @@ -29,7 +29,7 @@ Switch between visual and Markdown mode with the toggle in the toolbar. **Visual mode** shows a real-time preview as you type. Press / to open the component menu and insert components, images, videos, and other content. You can also drag and drop media files directly onto the page. Other shortcuts: -- **Insert a link**: Select text and press Cmd + K (macOS) or Ctrl + K (Windows), or drag a page from the navigation tree into the editor to create a link with the page title. +- **Insert a link**: Select text and press Cmd + K (macOS) or Ctrl + K (Windows). You can also drag a page from the navigation tree into the editor to create a link with the page title. - **Insert an emoji**: Type : followed by a keyword to open the emoji picker. - **Edit a table**: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells. @@ -43,7 +43,7 @@ For a full list of components, see [Components](/components). For MDX syntax, se ### Block actions -In visual mode, hover over any block to reveal a drag handle on the left. Click the handle to open a context menu with actions for that block: +In visual mode, hover over any block to reveal a drag handle on the left. Select the handle to open a context menu with actions for that block: - **Turn into**: Convert the block to a different type—text, headings, blockquote, or list. - **Duplicate**: Insert a copy of the block immediately after it. @@ -56,7 +56,7 @@ In visual mode, hover over any block to reveal a drag handle on the left. Click ### Table of contents -In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Click any heading to scroll to that section. +In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Select any heading to scroll to that section. ### Code block options @@ -69,9 +69,9 @@ 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 select 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 view is read-only. Select the button next to the mode toggle to return to editing. ## Manage pages @@ -86,7 +86,7 @@ If a teammate deletes a page through Git while you have it open, the editor ente ## Configure pages -Hover over a page and click the gear icon, or right-click and select **Settings**, to configure: +Hover over a page and select the gear icon, or right-click and select **Settings**, to configure: - **Title**, **Slug**, and **Sidebar title**: Control how the page appears in navigation and its URL. - **Description** and **Keywords**: Improve search and SEO. diff --git a/editor/share-a-preview.mdx b/editor/share-a-preview.mdx index 96e3a90f6..561099b5f 100644 --- a/editor/share-a-preview.mdx +++ b/editor/share-a-preview.mdx @@ -10,8 +10,8 @@ Every time you save changes to a feature branch, Mintlify builds a preview deplo ### Access your preview -1. Click **Publish** in the editor toolbar. -1. In the publish menu, click the preview URL. The URL format is `organization-branch-name.mintlify.app`. +1. Select **Publish** in the editor toolbar. +1. In the publish menu, select the preview URL. The URL format is `organization-branch-name.mintlify.app`. ### Share your preview diff --git a/editor/tutorial.mdx b/editor/tutorial.mdx index 006728914..be0707e3e 100644 --- a/editor/tutorial.mdx +++ b/editor/tutorial.mdx @@ -14,23 +14,23 @@ This tutorial walks you through a complete content update using the editor. You' Working on a branch keeps your edits separate from your live site until you're ready to share the content with your users. - 1. In the editor toolbar, click the branch name (usually `main`). + 1. In the editor toolbar, select the branch name (usually `main`). Branch name emphasized in the editor toolbar. Branch name emphasized in the editor toolbar. - 1. Click **Create new branch**. + 1. Select **Create new branch**. 1. Enter a name that describes your change, like `update-quickstart`. - 1. Click **Create branch**. + 1. Select **Create branch**. The editor switches to your new branch. Any changes you make are only on the branch. They only appear on your live site when you complete the publishing process. Edit an existing page or create a new one. - **To edit a page**: Click it in the navigation sidebar to open it. Type directly in the editor to add content. Press / to insert components, images, or other content. + **To edit a page**: Select it in the navigation sidebar to open it. Type directly in the editor to add content. Press / to insert components, images, or other content. - **To create a page**: Click the plus button next to the navigation group where you want to add the page, then click **Add a page** and enter a filename. + **To create a page**: Select the plus button next to the navigation group where you want to add the page, then select **Add a page** and enter a filename. The add page menu opened beside a group in the editor. @@ -43,14 +43,14 @@ This tutorial walks you through a complete content update using the editor. You' When you publish your branch, you make it available for review by your team. The changes only appear on your live site if you merge the pull request. - 1. Click **Publish** in the toolbar to open the publish menu. + 1. Select **Publish** in the toolbar to open the publish menu. The publish menu opened in the editor toolbar. The publish menu opened in the editor toolbar. - 1. Optionally, click any changed file in the list to view and compare your edits against the published version. - 1. Click **Save in branch** to save all changes on your branch. - 1. Click **Create pull request**. Add a title and description, then click **Publish pull request**. + 1. Optionally, select any changed file in the list to view and compare your edits against the published version. + 1. Select **Save in branch** to save all changes on your branch. + 1. Select **Create pull request**. Add a title and description, then select **Publish pull request**. 1. Continue to GitHub to view your pull request and review your changes. diff --git a/guides/assistant-embed.mdx b/guides/assistant-embed.mdx index 58c9732fc..c31dc4cb6 100644 --- a/guides/assistant-embed.mdx +++ b/guides/assistant-embed.mdx @@ -98,7 +98,7 @@ Replace `mint_dsc_your_token_here` with your assistant API key. npm run dev ``` -Open your application in a browser and click the **Ask** button to open the assistant widget. +Open your application in a browser and select the **Ask** button to open the assistant widget. diff --git a/guides/branches.mdx b/guides/branches.mdx index 8e5eec805..ef16a1d85 100644 --- a/guides/branches.mdx +++ b/guides/branches.mdx @@ -50,11 +50,11 @@ Use clear, descriptive names that explain the purpose of a branch. - 1. Click the branch name in the editor toolbar. - 1. Click **Create new branch**. + 1. Select the branch name in the editor toolbar. + 1. Select **Create new branch**. 1. Enter a descriptive name. 1. If you have unsaved changes, choose whether to bring them to the new branch or leave them on your current branch. - 1. Click **Create branch**. + 1. Select **Create branch**. @@ -97,9 +97,9 @@ Use clear, descriptive names that explain the purpose of a branch. - 1. Click the branch name in the editor toolbar to open the branch dropdown. + 1. Select the branch name in the editor toolbar to open the branch dropdown. 1. Search for a branch by name or scroll through the list. - 1. Click the branch you want to switch to. + 1. Select the branch you want to switch to. Each branch in the dropdown displays a status indicator so you can see whether it is ready, syncing, or failed. 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/optimize/feedback.mdx b/optimize/feedback.mdx index 89aef6bc8..d81d81ef5 100644 --- a/optimize/feedback.mdx +++ b/optimize/feedback.mdx @@ -120,7 +120,7 @@ Once enabled, Mintlify appends an `` 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..67862e803 100644 --- a/optimize/pdf-exports.mdx +++ b/optimize/pdf-exports.mdx @@ -31,7 +31,7 @@ PDF exports are not supported for documentation sites that use authentication. - **Include footer**: Include a footer with the page number and total pages. 4. Select **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. +6. Select the download link to download the PDF file. diff --git a/quickstart.mdx b/quickstart.mdx index e63558ca3..f5ea44a30 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -138,7 +138,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. + Select **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 379d4e7bc..e17c0ffbc 100644 --- a/workflows/enable.mdx +++ b/workflows/enable.mdx @@ -15,7 +15,7 @@ import GitlabWorkflowSetup from '/snippets/gitlab-workflow-setup.mdx'; ## Enable workflows 1. Open the [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) page in your dashboard. -2. Click the toggle beside a workflow to enable it. +2. Select the toggle beside a workflow to enable it. The workflows dashboard. The workflows dashboard. @@ -25,7 +25,7 @@ import GitlabWorkflowSetup from '/snippets/gitlab-workflow-setup.mdx'; The configuration options for the codebase updates workflow. The configuration options for the codebase updates workflow. -4. Click **Turn on workflow**. +4. Select **Turn on workflow**. ## Configurations diff --git a/workflows/manage.mdx b/workflows/manage.mdx index 59be92800..cb0d65888 100644 --- a/workflows/manage.mdx +++ b/workflows/manage.mdx @@ -7,7 +7,7 @@ keywords: ["manage workflows", "trigger workflow", "disable workflow", "enable w ## Disable a workflow 1. Go to the [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) page in your dashboard. -2. Click the toggle beside a workflow to disable it. +2. Select the toggle beside a workflow to disable it. When you re-enable a scheduled workflow, Mintlify recalculates the next run time from the current time. @@ -16,15 +16,15 @@ When you re-enable a scheduled workflow, Mintlify recalculates the next run time Deleting a workflow is permanent and removes its configuration and run history. 1. Go to the [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) page in your dashboard. -2. Click the settings button beside a workflow. -3. Click **Delete**. +2. Select the settings button beside a workflow. +3. Select **Delete**. ## View run history Each workflow keeps a log of past runs, including the status and a summary of changes made. 1. Go to the [Workflows](https://dashboard.mintlify.com/products/workflows) page in your dashboard. -2. Click a workflow. +2. Select a workflow. 3. Use the dropdown menus to filter by specific workflows or status. Workflow runs with the status filter menu open.