Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion assistant/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The CLI runs on your machine and connects to your Mintlify project when you need
</Visibility>

### 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.
Expand Down
4 changes: 2 additions & 2 deletions cli/mdx-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion deploy/deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

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.

Check warning on line 12 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L12

In general, use active voice instead of passive voice ('is connected').

## Manually trigger a deployment

Expand Down
2 changes: 1 addition & 1 deletion desktop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@
3. Sign in the same way you sign in to your dashboard in your browser.

<Note>
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.
</Note>

## Tabs and windows

Check warning on line 82 in desktop.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

desktop.mdx#L82

'Tabs and windows' should use sentence-style capitalization.

Open each page you're working on in its own tab or window. Tabs and windows reopen where you left them when you restart the app.

Expand Down
4 changes: 2 additions & 2 deletions editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
For other settings, open the page's options menu in the sidebar, or click <Icon icon="ellipsis" /> **More options** in the top-right of the page, and select **Page settings**. The **Page settings** panel groups settings into sections:

- **URL**: The page's path and redirect URL. Changing the path moves the file.
- **Navigation**: Sidebar title, tag, mode, and whether the page is hidden.

Check warning on line 54 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L54

In general, use active voice instead of passive voice ('is hidden').
- **SEO & sharing**: Open Graph image and keywords.

Groups, tabs, and other navigation elements have their own settings panels, like **Group settings** and **Tab settings**. Open them from the element's options menu. See [Pages](/organize/pages) for more information on specific settings.
Expand Down Expand Up @@ -96,7 +96,7 @@
- Videos play in the editor.
- `docs.json` opens in source mode.
- Text and code files, like YAML, JSON, and CSS, open in the source editor.
- Other files, like fonts and archives, can't be previewed in the editor.

Check warning on line 99 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L99

In general, use active voice instead of passive voice ('be previewed').

To upload files, drag them from your computer onto the **Files** section.

Expand All @@ -110,7 +110,7 @@
- The <Icon icon="ellipsis" /> menu next to a page in the sidebar.
- Right-clicking a page in the sidebar.

In the picker, search to filter folders, expand folders to see nested destinations, and select a folder to move the page. The current folder is marked **Current** and can't be selected. A toast with **Revert** appears after the move.

Check warning on line 113 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L113

In general, use active voice instead of passive voice ('is marked').

Check warning on line 113 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L113

In general, use active voice instead of passive voice ('be selected').

Moving a site page moves its file to the new folder. Editors and admins can move site pages. You can move workspace pages that you manage in **Personal** and **Teamspace**, but not pages in **Shared with me**.

Expand Down Expand Up @@ -156,7 +156,7 @@
- **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**.

Expand All @@ -166,7 +166,7 @@

To create a teamspace page or folder, click the <Icon icon="plus" /> 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

Expand Down
4 changes: 2 additions & 2 deletions es/cli/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ mint dev --disable-openapi
## Deshabilitar la precarga de navegación
</div>

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
Expand Down
4 changes: 2 additions & 2 deletions fr/guides/geo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<div id="allow-ai-agents-in-robotstxt">
### Autoriser les agents IA dans robots.txt
### Autorisez les agents IA dans robots.txt
</div>

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.
Expand Down Expand Up @@ -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.

<div id="frequently-asked-questions">
## Questions fréquemment posées
Expand Down
2 changes: 1 addition & 1 deletion guides/branches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Tab>
<Tab title="Using local development">
<Steps>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

When the Mintlify agent or an automation opens a pull request, it targets the deploy branch configured for your project (usually `main`). This is the branch Mintlify builds your live site from, so PRs land there by default and publish on merge.

If you want changes to go somewhere else, the control depends on how the run was started.

Check warning on line 9 in help-center/agent-opens-pull-requests-against-deploy-branch.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

help-center/agent-opens-pull-requests-against-deploy-branch.mdx#L9

In general, use active voice instead of passive voice ('was started').

## Agent runs in Slack, the editor, or the dashboard

Expand All @@ -15,7 +15,7 @@
- "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

Expand Down
2 changes: 1 addition & 1 deletion help-center/branch-missing-from-editor-branch-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
keywords: ["branch disappeared", "branch missing", "branch dropdown incomplete", "editor branch list", "branch deleted", "web editor branches", "switch branches", "git branch not showing"]
---

If you don't see the branch dropdown in the editor toolbar at all, it may be hidden by a personal preference. See [Show the branch selector](/editor/publish#show-the-branch-selector).

Check warning on line 7 in help-center/branch-missing-from-editor-branch-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

help-center/branch-missing-from-editor-branch-list.mdx#L7

In general, use active voice instead of passive voice ('be hidden').

If a branch that exists in your repository doesn't appear in the web editor's branch dropdown, the branch is not deleted. Before you type a search, the dropdown intentionally lists only:

Expand All @@ -13,16 +13,16 @@

## Find a branch with search

Type in the dropdown's search field to find branches that aren't in the default list:

Check warning on line 16 in help-center/branch-missing-from-editor-branch-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

help-center/branch-missing-from-editor-branch-list.mdx#L16

Did you really mean 'dropdown's'?

- Branches pushed directly to GitHub, GitLab, or Bitbucket without a pull request appear when your search matches part of the branch name. These rows show only the branch name, without pull request status or contributors.
- Branches whose pull request has been merged or closed appear when your search matches the branch name or pull request title.

Check warning on line 19 in help-center/branch-missing-from-editor-branch-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

help-center/branch-missing-from-editor-branch-list.mdx#L19

In general, use active voice instead of passive voice ('been merged').

Branches with a pull request opened from a fork still don't appear, because the branch lives in the fork rather than in your repository. See [Preview deployment not created for a fork branch](/help-center/preview-deployment-not-created-for-fork-branch) for related fork limitations.

## 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.

Check warning on line 25 in help-center/branch-missing-from-editor-branch-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

help-center/branch-missing-from-editor-branch-list.mdx#L25

In general, use active voice instead of passive voice ('are skipped').

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.

Expand Down
2 changes: 1 addition & 1 deletion help-center/site-search-returns-no-results.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading