Skip to content
Open
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 @@ -55,7 +55,7 @@

The assistant can generate page-specific questions based on the page a user is viewing or you can add persistent questions that are available across pages.

You can add up to three starter questions. Click **Ask AI** for recommended questions based on your documentation.
You can add up to three starter questions. Click **Ask Assistant** for recommended questions based on your documentation.

<Frame>
<img src="/images/assistant/search-suggestions-light.png" alt="The search suggestions panel in the dashboard with contextual starter questions enabled." className="block dark:hidden" />
Expand Down Expand Up @@ -83,19 +83,19 @@

If you have unused credits at the end of the month, up to half of your credit allowance can carry over to the next billing cycle. For example, if you have a 1,000 credit allowance and you use 300 credits, 500 credits carry over to the next billing cycle giving you a total of 1,500 credits for the next billing cycle.

By default, overages are disabled. With overages disabled, the assistant is unavailable once you reach your credit allowance and remains unavailable until your allowance resets. You can enable overages to keep the assistant available beyond your package allowance. If you enable overages, each credit beyond your allowance incurs an overage charge, but occasional overages may be cheaper than upgrading to a higher package depending on your usage.

Check warning on line 86 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L86

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

### Enable the assistant on the Hobby plan

If you're on the Hobby plan, you can add the assistant to your site by purchasing a credit package without upgrading to Pro. The assistant is enabled as soon as your purchase completes and remains active for as long as you have an active credit package.

Check warning on line 90 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L90

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

To purchase a credit package on the Hobby plan:

1. Go to the [Usage](https://dashboard.mintlify.com/settings/organization/usage) page of your dashboard.
2. In the **Credit packages** section, select a package from the dropdown menu.
3. Confirm the change to be redirected to checkout.

Check warning on line 96 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L96

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

To stop the assistant, downgrade your credit package to the lowest tier. Your plan returns to Hobby and the assistant is disabled at the end of the current billing cycle.

Check warning on line 98 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L98

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

### Change your assistant package

Expand All @@ -116,7 +116,7 @@

### Allow overages

Overages are disabled by default. To allow overages, enable them in the **Billing controls** section of the [Usage](https://dashboard.mintlify.com/settings/organization/usage) page of your dashboard.

Check warning on line 119 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L119

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

### Set usage alerts

Expand Down
6 changes: 3 additions & 3 deletions assistant/use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ Highlight text on a page and click the **Add to assistant** button to open the a

## 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.
Click the **Ask Assistant** 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.

<Frame>
<img src="/images/assistant/code-block-light.png" alt="The Ask AI button in a code block in light mode." className="block dark:hidden" />
<img src="/images/assistant/code-block-dark.png" alt="The Ask AI button in a code block in dark mode." className="hidden dark:block" />
<img src="/images/assistant/code-block-light.png" alt="The Ask Assistant button in a code block in light mode." className="block dark:hidden" />
<img src="/images/assistant/code-block-dark.png" alt="The Ask Assistant button in a code block in dark mode." className="hidden dark:block" />
</Frame>

## File attachments
Expand Down
2 changes: 1 addition & 1 deletion customize/custom-scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
- `#content-area` — Primary content area, excluding the sidebar and table of contents.
- `#content` — Inner content element within the content area.
- `#header` — Page-level header element.
- `#banner` — Announcement banner displayed above the navbar.

Check warning on line 67 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L67

Use 'preceding' instead of 'above'.
- `#footer` — Page footer. Also targetable as an element selector: `footer`.
- `#page-title` — The `<h1>` heading at the top of each page.
- `#pagination` — Bottom pagination bar with previous and next page links.
Expand All @@ -79,12 +79,12 @@
</Accordion>
<Accordion title="Sidebar">
- `#sidebar` — The sidebar navigation panel.
- `#sidebar-content` — Scrollable content area within the sidebar.

Check warning on line 82 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L82

Did you really mean 'Scrollable'?
</Accordion>
<Accordion title="Table of contents">
- `#table-of-contents` — Table of contents panel on the right side of the page.
- `#table-of-contents-layout` — Layout wrapper for the table of contents.
- `#table-of-contents-content` — Scrollable content within the table of contents.

Check warning on line 87 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L87

Did you really mean 'Scrollable'?
</Accordion>
<Accordion title="Search">
- `#search-bar-entry` — Search bar trigger in the topbar.
Expand All @@ -104,7 +104,7 @@
- `#endpoints-menu-trigger` — Button that opens the endpoint selector dropdown.
</Accordion>
<Accordion title="Code blocks">
- `#ask-ai-code-block-button` — "Ask AI" button that appears on code blocks.
- `#ask-assistant-code-block-button` — "Ask Assistant" button that appears on code blocks.
- `#code-snippet-feedback-button` — Feedback button on code snippets.
- `#code-snippet-feedback-textarea` — Text area within the code snippet feedback form.
</Accordion>
Expand All @@ -122,7 +122,7 @@
</Accordion>
<Accordion title="Localization">
- `#localization-select-trigger` — Button that opens the language selector.
- `#localization-select-content` — Dropdown content of the language selector.

Check warning on line 125 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L125

Use 'dropdowns?' instead of 'Dropdown'.
- `#localization-select-item` — Individual language option within the selector.
</Accordion>
<Accordion title="Changelog">
Expand All @@ -130,10 +130,10 @@
- `#changelog-filters-content` — Content area within the changelog filter panel.
</Accordion>
<Accordion title="Multi-view">
- `#multi-view-dropdown` — Dropdown for switching between documentation views.

Check warning on line 133 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L133

Use 'dropdowns?' instead of 'Dropdown'.
</Accordion>
<Accordion title="Text selection">
- `#text-selection-tooltip` — Tooltip that appears when text is selected on a page.

Check warning on line 136 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L136

In general, use active voice instead of passive voice ('is selected').
- `#text-selection-tooltip-button` — Action button within the text selection tooltip.
</Accordion>
</AccordionGroup>
Expand All @@ -146,7 +146,7 @@
<Accordion title="Content components">
- `accordion` — Collapsible accordion item.
- `accordion-group` — Wrapper grouping multiple accordions.
- `callout` — Callout block (Note, Warning, Tip, etc.).

Check warning on line 149 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L149

Use 'callouts?' instead of 'Callout'.
- `card` — Individual card element.
- `card-group` — Wrapper grouping multiple cards. Deprecated in favor of `columns`, but preserved for backward compatibility.
- `columns` — Multi-column layout wrapper.
Expand All @@ -168,9 +168,9 @@
<Accordion title="Page layout">
- `mdx-content` — Rendered MDX content area.
- `panel` — Floating panel component. Also targetable as an ID selector: `#panel`.
- `eyebrow` — Small label displayed above a page title.

Check warning on line 171 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L171

Use 'preceding' instead of 'above'.
- `link` — Anchor link element.
- `breadcrumb-list` — Breadcrumb navigation list.

Check warning on line 173 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L173

Use 'breadcrumbs?' instead of 'Breadcrumb'.
- `breadcrumb-item` — Individual breadcrumb item.
</Accordion>
<Accordion title="Topbar navigation">
Expand Down Expand Up @@ -228,7 +228,7 @@
- `api-section-heading-title` — Title within an API endpoint section heading.
- `api-section-heading-subtitle` — Subtitle within an API endpoint section heading.
- `field` — Parameter or property field in the API reference.
- `option-dropdown` — Dropdown for selecting between API options.

Check warning on line 231 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L231

Use 'dropdowns?' instead of 'Dropdown'.
- `tryit-button` — "Try it" button that opens the API playground.
- `method-pill` — HTTP method badge (GET, POST, etc.) on an endpoint.
- `method-nav-pill` — HTTP method badge shown in the sidebar navigation.
Expand All @@ -255,7 +255,7 @@
- `contextual-feedback-form-submit-button` — Submit button for the contextual feedback form.
</Accordion>
<Accordion title="Code snippet feedback">
- `code-snippet-feedback-popover-content` — Popover content for code snippet feedback.

Check warning on line 258 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L258

Use 'popovers?' instead of 'Popover'.
- `code-snippet-feedback-form` — Feedback form for a code snippet.
- `code-snippet-feedback-textarea` — Text area within the code snippet feedback form.
- `code-snippet-feedback-form-title` — Title of the code snippet feedback form.
Expand All @@ -268,7 +268,7 @@
</Accordion>
<Accordion title="Multi-view">
- `multi-view-item` — Individual view option in a multi-view switcher.
- `multi-view-dropdown` — Dropdown for selecting between multiple views.

Check warning on line 271 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L271

Use 'dropdowns?' instead of 'Dropdown'.
- `multi-view-dropdown-trigger` — Button that opens the multi-view dropdown.
- `multi-view-dropdown-content` — Content area of the multi-view dropdown.
- `multi-view-dropdown-item` — Individual item within the multi-view dropdown.
Expand Down
2 changes: 1 addition & 1 deletion es/assistant/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Ayuda a tus usuarios a iniciar conversaciones con el assistant agregando pregunt

El assistant puede generar preguntas específicas de la página basándose en la página que el usuario está viendo, o puedes agregar preguntas persistentes que estén disponibles en todas las páginas.

Puedes agregar hasta tres preguntas iniciales. Haz clic en **Ask AI** para obtener preguntas recomendadas basadas en tu documentación.
Puedes agregar hasta tres preguntas iniciales. Haz clic en **Ask Assistant** para obtener preguntas recomendadas basadas en tu documentación.

<Frame>
<img src="/images/assistant/search-suggestions-light.png" alt="El panel de sugerencias de búsqueda en el dashboard con preguntas iniciales contextuales habilitadas." className="block dark:hidden" />
Expand Down
6 changes: 3 additions & 3 deletions es/assistant/use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,11 @@ Resalta texto en una página y haz clic en el botón emergente **Add to assistan
## Bloques de código
</div>

Haz clic en el botón **Ask AI** en un bloque de código para abrir el panel de chat del assistant y agregar el bloque de código como contexto. Puedes agregar múltiples bloques de código o fragmentos de texto al contexto del assistant.
Haz clic en el botón **Ask Assistant** en un bloque de código para abrir el panel de chat del assistant y agregar el bloque de código como contexto. Puedes agregar múltiples bloques de código o fragmentos de texto al contexto del assistant.

<Frame>
<img src="/images/assistant/code-block-light.png" alt="El botón Ask AI en un bloque de código en modo claro." className="block dark:hidden" />
<img src="/images/assistant/code-block-dark.png" alt="El botón Ask AI en un bloque de código en modo oscuro." className="hidden dark:block" />
<img src="/images/assistant/code-block-light.png" alt="El botón Ask Assistant en un bloque de código en modo claro." className="block dark:hidden" />
<img src="/images/assistant/code-block-dark.png" alt="El botón Ask Assistant en un bloque de código en modo oscuro." className="hidden dark:block" />
</Frame>

<div id="file-attachments">
Expand Down
2 changes: 1 addition & 1 deletion es/customize/custom-scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Cada ID aparece una vez por página. Úsalos como `#value` en CSS. Por ejemplo,
- `#endpoints-menu-trigger` — Botón que abre el desplegable del selector de endpoints.
</Accordion>
<Accordion title="Bloques de código">
- `#ask-ai-code-block-button` — Botón "Ask AI" que aparece en los bloques de código.
- `#ask-assistant-code-block-button` — Botón "Ask Assistant" que aparece en los bloques de código.
- `#code-snippet-feedback-button` — Botón de retroalimentación en los fragmentos de código.
- `#code-snippet-feedback-textarea` — Área de texto dentro del formulario de retroalimentación de fragmentos de código.
</Accordion>
Expand Down
2 changes: 1 addition & 1 deletion fr/assistant/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Aidez vos utilisateurs à démarrer des conversations avec l'assistant en ajouta

L'assistant peut générer des questions spécifiques à la page en fonction de la page consultée par l'utilisateur, ou vous pouvez ajouter des questions persistantes disponibles sur toutes les pages.

Vous pouvez ajouter jusqu'à trois questions de démarrage. Cliquez sur **Ask AI** pour obtenir des questions recommandées basées sur votre documentation.
Vous pouvez ajouter jusqu'à trois questions de démarrage. Cliquez sur **Ask Assistant** pour obtenir des questions recommandées basées sur votre documentation.

<Frame>
<img src="/images/assistant/search-suggestions-light.png" alt="Le panneau de suggestions de recherche dans le tableau de bord avec les questions de démarrage contextuelles activées." className="block dark:hidden" />
Expand Down
6 changes: 3 additions & 3 deletions fr/assistant/use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,11 @@ Surlignez du texte sur une page et cliquez sur le bouton contextuel **Add to ass
## Blocs de code
</div>

Cliquez sur le bouton **Ask AI** dans un bloc de code pour ouvrir le panneau de chat de l'assistant et ajouter le bloc de code comme contexte. Vous pouvez ajouter plusieurs blocs de code ou extraits de texte au contexte de l'assistant.
Cliquez sur le bouton **Ask Assistant** dans un bloc de code pour ouvrir le panneau de chat de l'assistant et ajouter le bloc de code comme contexte. Vous pouvez ajouter plusieurs blocs de code ou extraits de texte au contexte de l'assistant.

<Frame>
<img src="/images/assistant/code-block-light.png" alt="Le bouton Ask AI dans un bloc de code en mode clair." className="block dark:hidden" />
<img src="/images/assistant/code-block-dark.png" alt="Le bouton Ask AI dans un bloc de code en mode sombre." className="hidden dark:block" />
<img src="/images/assistant/code-block-light.png" alt="Le bouton Ask Assistant dans un bloc de code en mode clair." className="block dark:hidden" />
<img src="/images/assistant/code-block-dark.png" alt="Le bouton Ask Assistant dans un bloc de code en mode sombre." className="hidden dark:block" />
</Frame>

<div id="file-attachments">
Expand Down
2 changes: 1 addition & 1 deletion fr/customize/custom-scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Chaque ID apparaît une seule fois par page. Utilisez-les comme `#value` en CSS.
- `#endpoints-menu-trigger` — Bouton qui ouvre le menu déroulant de sélection des endpoints.
</Accordion>
<Accordion title="Blocs de code">
- `#ask-ai-code-block-button` — Bouton "Ask AI" qui apparaît sur les blocs de code.
- `#ask-assistant-code-block-button` — Bouton "Ask Assistant" qui apparaît sur les blocs de code.
- `#code-snippet-feedback-button` — Bouton de retour d'expérience sur les extraits de code.
- `#code-snippet-feedback-textarea` — Zone de texte dans le formulaire de retour d'expérience des extraits de code.
</Accordion>
Expand Down
2 changes: 1 addition & 1 deletion zh/assistant/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ keywords: ["assistant", "设置", "转接", "机器人防护", "计费"]

AI 助手可以根据用户正在查看的页面生成特定于页面的问题,你也可以添加在所有页面上都可用的固定问题。

你最多可以添加三个示例问题。点击 **Ask AI** 获取基于你文档的推荐问题。
你最多可以添加三个示例问题。点击 **Ask Assistant** 获取基于你文档的推荐问题。

<Frame>
<img src="/images/assistant/search-suggestions-light.png" alt="仪表盘中的搜索建议面板,已启用上下文相关的示例问题。" className="block dark:hidden" />
Expand Down
6 changes: 3 additions & 3 deletions zh/assistant/use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,11 @@ https://yourdocs.mintlify.app/quickstart?assistant=How%20do%20I%20get%20started%
## 代码块
</div>

点击代码块中的 **Ask AI** 按钮,打开 AI 助手聊天面板并将代码块添加为上下文。你可以向 AI 助手的上下文中添加多个代码块或文本片段。
点击代码块中的 **Ask Assistant** 按钮,打开 AI 助手聊天面板并将代码块添加为上下文。你可以向 AI 助手的上下文中添加多个代码块或文本片段。

<Frame>
<img src="/images/assistant/code-block-light.png" alt="浅色模式下代码块中的 Ask AI 按钮。" className="block dark:hidden" />
<img src="/images/assistant/code-block-dark.png" alt="深色模式下代码块中的 Ask AI 按钮。" className="hidden dark:block" />
<img src="/images/assistant/code-block-light.png" alt="浅色模式下代码块中的 Ask Assistant 按钮。" className="block dark:hidden" />
<img src="/images/assistant/code-block-dark.png" alt="深色模式下代码块中的 Ask Assistant 按钮。" className="hidden dark:block" />
</Frame>

<div id="file-attachments">
Expand Down
2 changes: 1 addition & 1 deletion zh/customize/custom-scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Mintlify 提供两种类型的 CSS 定位钩子:
- `#endpoints-menu-trigger` — 打开端点选择器下拉菜单的按钮。
</Accordion>
<Accordion title="代码块">
- `#ask-ai-code-block-button` — 代码块上显示的 "Ask AI" 按钮。
- `#ask-assistant-code-block-button` — 代码块上显示的 "Ask Assistant" 按钮。
- `#code-snippet-feedback-button` — 代码片段上的反馈按钮。
- `#code-snippet-feedback-textarea` — 代码片段反馈表单内的文本区域。
</Accordion>
Expand Down
Loading