diff --git a/assistant/configure.mdx b/assistant/configure.mdx index 8100303a1..e04b94aef 100644 --- a/assistant/configure.mdx +++ b/assistant/configure.mdx @@ -14,7 +14,7 @@ On the [Assistant](https://app.mintlify.com/products/assistant) page in your das In the Response Handling section, enable the assistant to prompt users to contact your support and sales teams when it can't answer a question on its own. -Choose the **Email** deflection mode, then enter one or both of the following addresses: +Select the **Email** deflection mode, then enter one or both of the following addresses: - **Support**: For questions the assistant can't resolve from your documentation. - **Sales**: For questions about pricing, plans, or purchasing. diff --git a/cli/index.mdx b/cli/index.mdx index 385ff103c..86e4677e8 100644 --- a/cli/index.mdx +++ b/cli/index.mdx @@ -28,7 +28,7 @@ The CLI runs on your machine and connects to your Mintlify project when you need ### Preview locally -Run `mint dev` to preview your documentation at `localhost:3000`. As you write and update your content, changes appear in real time without deploying. Log in to enable search and the AI assistant in your local preview. +Run `mint dev` to preview your documentation at `localhost:3000`. As you write and update your content, changes appear in real time without deploying. Sign in to enable search and the AI assistant in your local preview. ### Run quality checks Run `mint broken-links` to find broken links, `mint a11y` to check accessibility, and `mint validate` to validate your documentation build before it reaches production. diff --git a/cli/mdx-extension.mdx b/cli/mdx-extension.mdx index d13c31145..2f4f8df19 100644 --- a/cli/mdx-extension.mdx +++ b/cli/mdx-extension.mdx @@ -83,7 +83,7 @@ The extension validates `docs.json` against the [Mintlify schema](https://mintli ## Visual mode -Open any `.mdx` file in visual mode to edit the page in a rich editor like the one in the Mintlify dashboard, with headings, lists, tables, links, callouts, cards, steps, tabs, accordions, code blocks, and images all editable in place. +Open any `.mdx` file in visual mode to edit the page in a rich editor like the one in the Mintlify dashboard. Headings, lists, tables, links, callouts, cards, steps, tabs, accordions, code blocks, and images are all editable in place. To switch between visual mode and the text editor: @@ -96,7 +96,7 @@ Markdown shortcuts work as you type (`#` for a heading, `-` for a list item, `** ### Snippet forms -In visual mode, a component imported from a snippet appears as a form with one input per prop instead of an opaque tag. Visual mode infers fields from the props in the component's function signature and their default values, so a default of `true` becomes a checkbox, `2` becomes a number box, `icon` or `logo` becomes an image path with a thumbnail, and `href` or `url` becomes a link. +In visual mode, a component imported from a snippet appears as a form with one input per prop instead of an opaque tag. Visual mode infers fields from the props in the component's function signature and their default values. A default of `true` becomes a checkbox, `2` becomes a number box, `icon` or `logo` becomes an image path with a thumbnail, and `href` or `url` becomes a link. To control the inputs, document the component with a JSDoc `@param` comment right before the export. In `.jsx` and `.tsx` files use a `/** … */` block. In `.mdx` snippets, use an MDX comment (`{/* … */}`) so it doesn't render: diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index 95cff57b7..458bf58c1 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -7,7 +7,7 @@ boost: 3 Your documentation site automatically deploys when you push changes to your connected repository. If your repository is on GitHub, you must install and connect the Mintlify GitHub App. If your repository is on GitLab or Bitbucket, see [GitLab](/deploy/gitlab) or [Bitbucket](/deploy/bitbucket) for connection setup. -If your latest changes are not appearing on your live site and your repository is on GitHub, first check that the GitHub account or organization that owns your docs repository has the GitHub App installed. For more information, see [GitHub troubleshooting](/deploy/github#troubleshooting). +If your latest changes are not appearing on your live site and your repository is on GitHub, first check the GitHub App installation. The GitHub account or organization that owns your docs repository must have the GitHub App installed. For more information, see [GitHub troubleshooting](/deploy/github#troubleshooting). If your repository is connected, but changes are still not deploying, manually trigger a deployment from your dashboard. diff --git a/desktop.mdx b/desktop.mdx index f6ec2dbe3..08b8332ed 100644 --- a/desktop.mdx +++ b/desktop.mdx @@ -76,7 +76,7 @@ The desktop app updates content the same way the editor does. It does not open o 3. Sign in the same way you sign in to your dashboard in your browser. - Browser-based login is not available during beta access. You cannot use the **Continue in browser** button to sign in. + Browser-based sign-in is not available during beta access. You cannot use the **Continue in browser** button to sign in. ## Tabs and windows diff --git a/editor/pages.mdx b/editor/pages.mdx index b4f43b0fa..0eb19bb5a 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -156,7 +156,7 @@ To share a private page, open it and click **Share** in the top bar. To share a - **Editor**: Create and edit content. - **Viewer**: View content only. -Under general access, choose **Only people invited** or **Everyone at** your organization. Only people with **Full Access** can change who has access. +Under general access, select **Only people invited** or **Everyone at** your organization. Only people with **Full Access** can change who has access. Pages shared with you appear in **Shared with me**. To remove a page from your sidebar, open its options menu and select **Leave**. @@ -166,7 +166,7 @@ Teamspace pages are available to everyone in your organization. Like private pag To create a teamspace page or folder, click the plus button on the **Teamspace** section header, then select **New page** or **New folder**. -To move a private page into teamspace, drag it from **Personal** into **Teamspace**, or open its options menu, select **Move to**, and choose **Teamspace**. You can move pages, but not folders. +To move a private page into teamspace, drag it from **Personal** into **Teamspace**, or open its options menu, select **Move to**, and select **Teamspace**. You can move pages, but not folders. ## Move a page to your site diff --git a/es/cli/preview.mdx b/es/cli/preview.mdx index 66f5aafb1..82c9e63c6 100644 --- a/es/cli/preview.mdx +++ b/es/cli/preview.mdx @@ -91,9 +91,9 @@ mint dev --disable-openapi ## Deshabilitar la precarga de navegación -De forma predeterminada, la vista previa local precarga las páginas cercanas para que la navegación entre ellas se sienta instantánea. En sitios muy grandes, esto puede ralentizar la página que estás viendo, porque muchas páginas se compilan en segundo plano al mismo tiempo. +De forma predeterminada, la previsualización local precarga las páginas cercanas para que la navegación entre ellas se sienta instantánea. En sitios muy grandes, esto puede ralentizar la página que estás viendo, porque muchas páginas se compilan en segundo plano al mismo tiempo. -Si tienes miles de páginas y notas cargas de página lentas durante la vista previa local, deshabilita la precarga con el flag `--disable-prefetch`: +Si tienes miles de páginas y notas cargas de página lentas durante la previsualización local, deshabilita la precarga con el flag `--disable-prefetch`: ```bash mint dev --disable-prefetch diff --git a/fr/guides/geo.mdx b/fr/guides/geo.mdx index fe7726ff9..c0778e0f2 100644 --- a/fr/guides/geo.mdx +++ b/fr/guides/geo.mdx @@ -172,7 +172,7 @@ Mintlify génère automatiquement un fichier `llms.txt` pour votre documentation Vous pouvez consulter votre LLMs.txt en ajoutant `/llms.txt` à l'URL de votre documentation.
-### Autoriser les agents IA dans robots.txt +### Autorisez les agents IA dans robots.txt
Votre fichier `robots.txt` contrôle quels robots peuvent explorer votre site. S'il bloque les agents utilisateurs IA, des outils comme ChatGPT, Claude et Perplexity ne peuvent pas lire votre documentation ni la citer dans leurs réponses. @@ -221,7 +221,7 @@ Vérifiez dans les réponses : - Si les exemples de code sont corrects - Si l'IA recommande la bonne approche -Lorsque les outils d'IA donnent de mauvaises réponses sur votre produit, cela signale souvent que votre documentation est ambiguë, incomplète ou contradictoire, plutôt que l'IA est défaillante. +Lorsque les outils d'IA donnent de mauvaises réponses sur votre produit, cela signale souvent que votre documentation est ambiguë, incomplète ou contradictoire, plutôt qu'une défaillance de l'IA.
## Questions fréquemment posées diff --git a/guides/branches.mdx b/guides/branches.mdx index af76c0f9e..b9e90b4b4 100644 --- a/guides/branches.mdx +++ b/guides/branches.mdx @@ -53,7 +53,7 @@ Use clear, descriptive names that explain the purpose of a branch. 1. Click the branch name in the editor toolbar. If you don't see it, [show the branch selector](/editor/publish#show-the-branch-selector). 1. In **Find a branch**, type a descriptive title. If you leave it empty, the editor names the branch after the current date. 1. Click **New branch**. - 1. If you have pending changes, choose **Bring them to this branch** or **Leave them behind**. Your original branch keeps its pending changes either way. + 1. If you have pending changes, select **Bring them to this branch** or **Leave them behind**. Your original branch keeps its pending changes either way. diff --git a/help-center/agent-opens-pull-requests-against-deploy-branch.mdx b/help-center/agent-opens-pull-requests-against-deploy-branch.mdx index 50dee3e32..57245365c 100644 --- a/help-center/agent-opens-pull-requests-against-deploy-branch.mdx +++ b/help-center/agent-opens-pull-requests-against-deploy-branch.mdx @@ -15,7 +15,7 @@ For a single agent run, name the branch you want in the prompt. The agent create - "Open the PR against the `staging` branch." - "Push these commits to `docs-refresh`." -See [Send messages to the agent](/agent/slack) for the Slack flow and [Choose how the agent publishes changes](/agent/index#choose-how-the-agent-publishes-changes) for the workspace-level review process setting that decides between opening a PR and pushing directly to your deploy branch. +See [Send messages to the agent](/agent/slack) for the Slack flow. See [Choose how the agent publishes changes](/agent/index#choose-how-the-agent-publishes-changes) for the workspace-level review process setting that decides between opening a PR and pushing directly to your deploy branch. ## Automations diff --git a/help-center/branch-missing-from-editor-branch-list.mdx b/help-center/branch-missing-from-editor-branch-list.mdx index 206b9b470..c8882276a 100644 --- a/help-center/branch-missing-from-editor-branch-list.mdx +++ b/help-center/branch-missing-from-editor-branch-list.mdx @@ -22,7 +22,7 @@ Branches with a pull request opened from a fork still don't appear, because the ## Work with a branch that has no pull request -You can open a branch without a pull request by searching for it in the dropdown and selecting it. Until a pull request against your deployment branch exists, branch-specific editor features are unavailable: automatic commits are skipped, the review view can't load a diff, and you can't rename or delete the branch from the editor. +You can open a branch without a pull request by searching for it in the dropdown and selecting it. Until a pull request against your deployment branch exists, branch-specific editor features are unavailable. Automatic commits are skipped, the review view can't load a diff, and you can't rename or delete the branch from the editor. Open a pull request or merge request for the branch against your deployment branch, from a branch in the same repository rather than a fork. The branch then appears in the editor's branch dropdown with full editor support. diff --git a/help-center/site-search-returns-no-results.mdx b/help-center/site-search-returns-no-results.mdx index 4dfc8cd36..7cda922d2 100644 --- a/help-center/site-search-returns-no-results.mdx +++ b/help-center/site-search-returns-no-results.mdx @@ -4,7 +4,7 @@ description: "Diagnose why your documentation site's built-in search returns no keywords: ["search returns no results", "empty search", "search broken", "hidden version", "search index empty", "site search"] --- -If the built-in search on your Mintlify documentation site returns no results for any query, including exact page titles, your pages are likely excluded from the search index by a `hidden` setting in your `docs.json`. +If the built-in search on your Mintlify documentation site returns no results for any query, including exact page titles, a `hidden` setting in your `docs.json` likely excludes your pages from the search index. ## Check for `hidden: true` on a version or other top-level navigation element