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
13 changes: 13 additions & 0 deletions assistant/widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

export const WidgetCodeBlock = ({ children, ...props }) => (
<CodeBlock {...props}>{children}</CodeBlock>
);

Check warning on line 13 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L13

Use semicolons judiciously.

The [assistant](/assistant) answers questions on your Mintlify site. To embed the same capability on another site or web app, use the widget. With the widget, you can give your users access to AI chat trained on your content in your product dashboard, marketing site, support portal, or elsewhere.

Expand All @@ -37,7 +37,7 @@
Replace `YOUR_WIDGET_ID` in the generated code with the widget ID from the [Widget](https://app.mintlify.com/settings/deployment/widget) page of your dashboard.
</Info>

After you add the generated code to your site, reload the page. Confirm the trigger appears, then click it and send a test question to verify the widget is connected.

Check warning on line 40 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L40

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

<AssistantWidgetPlayground CodeBlockComponent={WidgetCodeBlock}>

Expand Down Expand Up @@ -132,6 +132,19 @@

You can supply `supportEmail` and `starterQuestions` during initialization and change them later with `update()`. These values apply to the current embed and do not inherit from your Mintlify dashboard.

## Authenticate end users

Pass a signed `identity` token to `init()` or `update()` to associate a widget session with a specific end user. Omit `identity` for anonymous visitors.

Identity tokens are only verified when your deployment has [JWT authentication](/deploy/authentication-setup) configured. Sign each token on your server with the same private key you registered on the [Authentication](https://app.mintlify.com/settings/deployment/authentication) page in your dashboard, and include the following claims:

- `sub`: A stable identifier for the end user.
- `aud`: The widget ID.
- `iat`: The token issue time.
- `exp`: The token expiration time. Keep the lifetime short and refresh tokens from your backend before they expire.

Sign tokens with `EdDSA` or `ES256`. Never expose your private key or generate tokens in the browser.

## Configuration reference

### `AssistantConfig`
Expand Down Expand Up @@ -159,7 +172,7 @@
| `theme` | `light`, `dark`, `system` | Sets the widget color scheme. The default is `system`. |
| `accent` | CSS color | Sets the color of primary controls. |
| `radius` | CSS border radius | Sets the panel radius, such as `18px`. |
| `font` | CSS font family | Uses a font already loaded by your application. The default is bundled Inter. |

Check warning on line 175 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L175

In general, use active voice instead of passive voice ('is bundled').
| `side` | `top`, `bottom`, `left`, `right`, `inline-start`, `inline-end` | Positions the built-in trigger on a screen edge. |
| `align` | `start`, `center`, `end` | Aligns the trigger along its selected edge. |
| `dismissOnInteractOutside` | boolean | Controls whether pointer or focus interactions outside close the assistant. |
Expand All @@ -176,7 +189,7 @@
| `trigger` | string or `null` | Sets the compact widget and panel trigger text. |
| `placeholder` | string or `null` | Sets the composer and modal trigger placeholder. |
| `disclaimer` | string, `false`, or `null` | Sets the empty-state disclaimer. Pass `false` to hide it. |
| `suggestions` | string or `null` | Sets the heading above starter questions. The default is `Suggestions`. |

Check warning on line 192 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L192

Use 'preceding' instead of 'above'.

### `AssistantHooks`

Expand Down Expand Up @@ -241,7 +254,7 @@

Conversation snapshots remain private to the widget. Each method resolves to `void`.

## Content Security Policy

Check warning on line 257 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L257

'Content Security Policy' should use sentence-style capitalization.

If your site uses a Content Security Policy, allow the origins required by your enabled widget features:

Expand All @@ -251,9 +264,9 @@
| `connect-src` | `https://api.mintlify.com` | Widget API |
| `style-src` | `https://cdn.jsdelivr.net` | Widget style sheet |
| `font-src` | `https://cdn.jsdelivr.net` | Optional bundled Inter font |
| `script-src`, `connect-src`, and `frame-src` | `https://challenges.cloudflare.com` | Turnstile bot protection |

Check warning on line 267 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L267

Use 'Cloudflare' instead of 'cloudflare'.
| `script-src` | `https://js.hcaptcha.com` | hCaptcha bot protection |

Check warning on line 268 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L268

Use 'hCaptcha' instead of 'hcaptcha'.
| `connect-src` and `frame-src` | `https://*.hcaptcha.com` | hCaptcha bot protection |

Check warning on line 269 in assistant/widget.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/widget.mdx#L269

Use 'hCaptcha' instead of 'hcaptcha'.

A strict `script-src` policy must still authorize both the loader and initialization script. Passing `nonce` to `init()` propagates it only to resources the widget creates after initialization.

Expand Down
4 changes: 3 additions & 1 deletion deploy/reverse-proxy.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
title: "Reverse proxy"
description: "Configure a custom reverse proxy with Nginx, Apache, or Caddy to serve your Mintlify documentation at a subpath on your own domain."
description: "Configure a custom reverse proxy with Nginx routing rules, caching, and header forwarding to serve Mintlify docs at a subpath on your own domain."
keywords: ["reverse proxy configuration","nginx","proxy routing","header forwarding"]
---

import SubpathSetupSteps from "/snippets/subpath-setup-steps.mdx";

To serve your documentation through a custom reverse proxy, you must configure routing rules, caching policies, and header forwarding.

The routing paths, HTTP methods, and header requirements on this page apply to any reverse proxy. The example configurations use Nginx. Adapt them to another proxy such as Apache, Caddy, or HAProxy by translating each directive to the equivalent syntax.

Check warning on line 11 in deploy/reverse-proxy.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/reverse-proxy.mdx#L11

Did you really mean 'HAProxy'?

When you implement a reverse proxy, monitor for potential issues with domain verification, SSL certificate provisioning, authentication flows, performance, and analytics tracking.

## Set your base path
Expand Down
15 changes: 15 additions & 0 deletions es/assistant/widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,21 @@ Cambiar `identity` inicia una nueva conversación. Cambiar el ID del widget o el

Puedes proporcionar `supportEmail` y `starterQuestions` durante la inicialización y cambiarlos más tarde con `update()`. Estos valores se aplican al embed actual y no se heredan desde tu panel de Mintlify.

<div id="authenticate-end-users">
## Autenticar a los usuarios finales
</div>

Pasa un token de `identity` firmado a `init()` o `update()` para asociar una sesión del widget con un usuario final específico. Omite `identity` para visitantes anónimos.

Los tokens de identidad solo se verifican cuando tu despliegue tiene configurada la [autenticación JWT](/es/deploy/authentication-setup). Firma cada token en tu servidor con la misma clave privada que registraste en la página [Authentication](https://app.mintlify.com/settings/deployment/authentication) de tu panel e incluye las siguientes claims:

- `sub`: Un identificador estable para el usuario final.
- `aud`: El ID del widget.
- `iat`: La hora de emisión del token.
- `exp`: La hora de expiración del token. Mantén una vida útil corta y refresca los tokens desde tu backend antes de que expiren.

Firma los tokens con `EdDSA` o `ES256`. Nunca expongas tu clave privada ni generes tokens en el navegador.

<div id="configuration-reference">
## Referencia de configuración
</div>
Expand Down
4 changes: 3 additions & 1 deletion es/deploy/reverse-proxy.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
title: "Proxy inverso"
description: "Configura un proxy inverso personalizado con Nginx, Apache o Caddy para servir tu documentación de Mintlify en una subruta de tu propio dominio."
description: "Configura un proxy inverso personalizado con reglas de enrutamiento de Nginx, caché y reenvío de encabezados para servir la documentación de Mintlify en una subruta de tu propio dominio."
keywords: ["reverse proxy configuration","nginx","proxy routing","header forwarding"]
---

import SubpathSetupSteps from "/snippets/es/subpath-setup-steps.mdx";

Para publicar tu documentación a través de un proxy inverso personalizado, debes configurar reglas de enrutamiento, políticas de caché y reenvío de encabezados.

Las rutas de enrutamiento, los métodos HTTP y los requisitos de encabezados de esta página se aplican a cualquier proxy inverso. Las configuraciones de ejemplo usan Nginx. Adáptalas a otro proxy como Apache, Caddy o HAProxy traduciendo cada directiva a la sintaxis equivalente.

Al implementar un proxy inverso, supervisa posibles problemas con la verificación del dominio, el aprovisionamiento de certificados SSL, los flujos de autenticación, el rendimiento y el seguimiento de analíticas.

<div id="set-your-base-path">
Expand Down
23 changes: 22 additions & 1 deletion es/migration-services/go-live-checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,25 @@ Esta es una lista completa de configuraciones que debes establecer y ajustes que

- **Verifica tu arquitectura de la información.** ¿Es esta la estructura de navegación adecuada? ¿Faltan secciones? Consulta [tipos de contenido](/es/guides/content-types) como referencia.
- **Verifica que tu información esté actualizada.** ¿Se reflejan todos los cambios de contenido recientes en tu sitio?
- Si es necesario, configura [redirecciones](/es/create/redirects).
- Si es necesario, configura [redirecciones](/es/create/redirects). Prueba cada redirección en un navegador para confirmar que devuelve el destino esperado.

<div id="security-verification">
## Verificación de seguridad
</div>

- Verifica el [SSO del panel](/es/dashboard/sso) iniciando sesión como usuario de prueba desde tu proveedor de identidad.
- Verifica el [aprovisionamiento SCIM](/es/dashboard/scim) aprovisionando un usuario de prueba y confirmando que aparezca en la lista de miembros de tu panel.
- Verifica la [autenticación](/es/deploy/authentication-setup) del sitio iniciando sesión como miembro de cada grupo de acceso y confirmando que las páginas restringidas sean visibles solo para los grupos esperados.

<div id="seo">
## SEO
</div>

- Revisa los títulos de página, descripciones y encabezados de las páginas con más tráfico. Consulta [Cómo mejorar el SEO de la documentación](/es/guides/seo).
- Confirma que tu sitemap sea accesible en `https://<your-docs-domain>/sitemap.xml`.
- Envía tu sitemap a [Google Search Console](https://search.google.com/search-console) y a cualquier otra consola de búsqueda que uses.
- Elimina `noindex: true` de cualquier página que se haya ocultado de la búsqueda durante el staging pero que deba ser detectable en el lanzamiento.
- Configura imágenes OG y metaetiquetas específicas por página para las páginas que esperas que se compartan. Consulta [SEO](/es/optimize/seo).

<div id="dashboard-features">
## Funciones del panel
Expand All @@ -53,3 +71,6 @@ Esta es una lista completa de configuraciones que debes establecer y ajustes que
</div>

- **Configura tu dominio personalizado.** Consulta la [guía de dominios personalizados](/es/customize/custom-domain).
- **Verifica que el DNS resuelva** hacia tu sitio de Mintlify desde el dominio personalizado.
- **Verifica que el certificado TLS** sea válido y no haya expirado.
- **Verifica las redirecciones del dominio anterior** para asegurarte de que envíen a los visitantes a las páginas correctas en el nuevo dominio.
11 changes: 11 additions & 0 deletions es/organize/related-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,17 @@ En el modo **Automático**, las páginas relacionadas se generan a partir del í

Para las implementaciones con [autenticación de usuario final](/es/deploy/authentication-setup), las sugerencias automáticas están deshabilitadas para evitar filtrar contenido entre contextos de usuario. Usa el campo de frontmatter `related` para mostrar sugerencias seleccionadas en implementaciones autenticadas por usuario.

<div id="when-suggestions-dont-appear">
## Cuando las sugerencias no aparecen
</div>

Si la sección **Temas relacionados** aparece vacía en una página en el modo **Automático**:

- El índice de búsqueda puede que aún no esté listo. Las sugerencias automáticas se reconstruyen después de cada despliegue, así que espera unos minutos después de publicar contenido nuevo y recarga la página.
- Es posible que tu documentación no contenga suficiente contenido similar para que Mintlify pueda recomendar. Las sugerencias automáticas se obtienen del mismo idioma y versión de la página, por lo que un conjunto pequeño de documentos o una localización poco poblada puede no devolver coincidencias.
- La autenticación de usuario final está habilitada. En su lugar, selecciona sugerencias con el campo de frontmatter `related`.
- La página usa `related: false` y la sección está oculta intencionalmente.

<div id="related-resources">
## Recursos relacionados
</div>
Expand Down
15 changes: 15 additions & 0 deletions fr/assistant/widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,21 @@ La modification de `identity` démarre une nouvelle conversation. La modificatio

Vous pouvez fournir `supportEmail` et `starterQuestions` lors de l'initialisation et les modifier ultérieurement avec `update()`. Ces valeurs s'appliquent à l'intégration en cours et ne sont pas héritées de votre tableau de bord Mintlify.

<div id="authenticate-end-users">
## Authentifier les utilisateurs finaux
</div>

Passez un jeton `identity` signé à `init()` ou `update()` pour associer une session du widget à un utilisateur final spécifique. Omettez `identity` pour les visiteurs anonymes.

Les jetons d'identité ne sont vérifiés que lorsque votre déploiement est configuré avec l'[authentification JWT](/fr/deploy/authentication-setup). Signez chaque jeton sur votre serveur avec la même clé privée que vous avez enregistrée sur la page [Authentification](https://app.mintlify.com/settings/deployment/authentication) de votre tableau de bord, et incluez les revendications suivantes :

- `sub` : un identifiant stable pour l'utilisateur final.
- `aud` : l'ID du widget.
- `iat` : la date d'émission du jeton.
- `exp` : la date d'expiration du jeton. Gardez une durée de vie courte et renouvelez les jetons depuis votre backend avant leur expiration.

Signez les jetons avec `EdDSA` ou `ES256`. N'exposez jamais votre clé privée et ne générez jamais de jetons dans le navigateur.

<div id="configuration-reference">
## Référence de configuration
</div>
Expand Down
4 changes: 3 additions & 1 deletion fr/deploy/reverse-proxy.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
title: "Proxy inverse"
description: "Configurez un proxy inverse personnalisé avec Nginx, Apache ou Caddy pour servir votre documentation Mintlify sur un sous-chemin de votre propre domaine."
description: "Configurez un proxy inverse personnalisé avec des règles de routage Nginx, la mise en cache et la transmission des en-têtes pour servir la documentation Mintlify sur un sous-chemin de votre propre domaine."
keywords: ["configuration de proxy inverse", "nginx", "routage du proxy", "transmission des en-têtes"]
---

import SubpathSetupSteps from "/snippets/fr/subpath-setup-steps.mdx";

Pour diffuser votre documentation via un proxy inverse personnalisé, vous devez configurer des règles de routage, des stratégies de mise en cache et la transmission des en-têtes.

Les chemins de routage, les méthodes HTTP et les exigences d'en-têtes présentés sur cette page s'appliquent à n'importe quel proxy inverse. Les exemples de configuration utilisent Nginx. Adaptez-les à un autre proxy tel qu'Apache, Caddy ou HAProxy en traduisant chaque directive vers la syntaxe équivalente.

Lorsque vous mettez en place un proxy inverse, surveillez les problèmes potentiels liés à la vérification du domaine, à l’émission des certificats SSL, aux parcours d’authentification, aux performances et au suivi Analytics.

<div id="set-your-base-path">
Expand Down
23 changes: 22 additions & 1 deletion fr/migration-services/go-live-checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,25 @@ Voici une liste complète des configurations à mettre en place et des paramètr

- **Vérifiez votre architecture de l'information.** La structure de navigation est-elle appropriée ? Manque-t-il des sections ? Consultez les [types de contenu](/fr/guides/content-types) pour référence.
- **Vérifiez que vos informations sont à jour.** Toutes les modifications récentes de contenu sont-elles reflétées sur votre site ?
- Si nécessaire, configurez des [redirections](/fr/create/redirects).
- Si nécessaire, configurez des [redirections](/fr/create/redirects). Testez chaque redirection dans un navigateur pour confirmer qu'elle renvoie vers la destination attendue.

<div id="security-verification">
## Vérification de la sécurité
</div>

- Vérifiez le [SSO du tableau de bord](/fr/dashboard/sso) en vous connectant en tant qu'utilisateur test depuis votre fournisseur d'identité.
- Vérifiez le [provisionnement SCIM](/fr/dashboard/scim) en provisionnant un utilisateur test et en confirmant qu'il apparaît dans la liste des membres de votre tableau de bord.
- Vérifiez l'[authentification](/fr/deploy/authentication-setup) du site en vous connectant en tant que membre de chaque groupe d'accès et en confirmant que les pages restreintes ne sont visibles que par les groupes attendus.

<div id="seo">
## SEO
</div>

- Passez en revue les titres, descriptions et en-têtes des pages à plus fort trafic. Consultez [Comment améliorer le SEO de la documentation](/fr/guides/seo).
- Confirmez que votre sitemap est accessible à l'adresse `https://<your-docs-domain>/sitemap.xml`.
- Soumettez votre sitemap à [Google Search Console](https://search.google.com/search-console) et à toute autre console de recherche que vous utilisez.
- Retirez `noindex: true` de toute page qui a été masquée à la recherche pendant la phase de staging mais qui devrait être découvrable au lancement.
- Définissez les images OG et les balises meta spécifiques aux pages que vous prévoyez de voir partagées. Consultez [SEO](/fr/optimize/seo).

<div id="dashboard-features">
## Fonctionnalités du tableau de bord
Expand All @@ -53,3 +71,6 @@ Voici une liste complète des configurations à mettre en place et des paramètr
</div>

- **Définissez votre domaine personnalisé.** Consultez le [guide sur le domaine personnalisé](/fr/customize/custom-domain).
- **Vérifiez que le DNS résout** vers votre site Mintlify depuis le domaine personnalisé.
- **Vérifiez que le certificat TLS** est valide et n'est pas expiré.
- **Vérifiez les redirections depuis l'ancien domaine** en confirmant qu'elles envoient les visiteurs vers les bonnes pages sur le nouveau domaine.
11 changes: 11 additions & 0 deletions fr/organize/related-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,17 @@ En mode **Automatic**, les pages associées sont générées à partir de l'inde

Pour les déploiements avec [authentification des utilisateurs finaux](/fr/deploy/authentication-setup), les suggestions automatiques sont désactivées afin d'éviter les fuites de contenu entre contextes utilisateur. Utilisez le champ de frontmatter `related` pour afficher des suggestions sélectionnées sur les déploiements avec authentification utilisateur.

<div id="when-suggestions-dont-appear">
## Lorsque les suggestions n'apparaissent pas
</div>

Si la section **Sujets associés** est vide sur une page en mode **Automatic** :

- L'index de recherche n'est peut-être pas encore prêt. Les suggestions automatiques sont reconstruites après chaque déploiement, donc attendez quelques minutes après la publication du nouveau contenu et rechargez la page.
- Votre documentation ne contient peut-être pas assez de contenu similaire pour que Mintlify puisse faire des recommandations. Les suggestions automatiques sont tirées de la même langue et version que la page, donc un petit ensemble de documentation ou une locale peu remplie peut ne renvoyer aucun résultat.
- L'authentification des utilisateurs finaux est activée. Sélectionnez les suggestions avec le champ de frontmatter `related` à la place.
- La page utilise `related: false` et la section est masquée intentionnellement.

<div id="related-resources">
## Ressources associées
</div>
Expand Down
19 changes: 18 additions & 1 deletion migration-services/go-live-checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,21 @@

- **Verify your information architecture.** Is this the proper navigation structure? Are there missing sections? See [content types](/guides/content-types) for reference.
- **Verify your information is up-to-date.** Are all recent content changes reflected on your site?
- If required, set up [redirects](/create/redirects).
- If required, set up [redirects](/create/redirects). Test each redirect in a browser to confirm it returns the expected destination.

## Security verification

- Verify [dashboard SSO](/dashboard/sso) by signing in as a test user from your identity provider.
- Verify [SCIM provisioning](/dashboard/scim) by provisioning a test user and confirming they appear in your dashboard members list.
- Verify site [authentication](/deploy/authentication-setup) by signing in as a member of each access group and confirming that restricted pages are visible only to the expected groups.

## SEO

- Review page titles, descriptions, and headings for the highest-traffic pages. See [How to improve documentation SEO](/guides/seo).
- Confirm your sitemap is reachable at `https://<your-docs-domain>/sitemap.xml`.
- Submit your sitemap to [Google Search Console](https://search.google.com/search-console) and any other search consoles you use.
- Remove `noindex: true` from any pages that were hidden from search during staging but should be discoverable at launch.

Check warning on line 43 in migration-services/go-live-checklist.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/go-live-checklist.mdx#L43

In general, use active voice instead of passive voice ('were hidden').
- Set OG images and page-specific meta tags for the pages you expect to be shared. See [SEO](/optimize/seo).

Check warning on line 44 in migration-services/go-live-checklist.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/go-live-checklist.mdx#L44

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

## Dashboard features

Expand All @@ -43,3 +57,6 @@
## Go live

- **Set your custom domain.** See the [custom domain guide](/customize/custom-domain).
- **Verify DNS resolves** to your Mintlify site from the custom domain.
- **Verify the TLS certificate** is valid and not expired.
- **Verify old-domain redirects** send visitors to the correct pages on the new domain.
9 changes: 9 additions & 0 deletions organize/related-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</ResponseField>

<ResponseField name="Manual" type="mode">
Only pages listed in a page's `related` frontmatter are shown. Pages without a `related` field display no **Related topics** section. Use this mode when you want full editorial control.

Check warning on line 22 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L22

In general, use active voice instead of passive voice ('are shown').
</ResponseField>

### Limit
Expand Down Expand Up @@ -76,9 +76,18 @@
---
```

## How suggestions are generated

Check warning on line 79 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L79

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

In **Automatic** mode, related pages are generated from your docs' search index using the current page's title as the query. Results are filtered by the page's language and version when applicable, and the current page is excluded.

Check warning on line 81 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L81

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

Check warning on line 81 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L81

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

Check warning on line 81 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L81

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

For deployments with [end-user authentication](/deploy/authentication-setup), automatic suggestions are disabled to avoid leaking content across user contexts. Use the `related` frontmatter field to show curated suggestions on user-authenticated deployments.

Check warning on line 83 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L83

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

## When suggestions don't appear

If the **Related topics** section is empty on a page in **Automatic** mode:

- The search index may not be ready yet. Automatic suggestions rebuild after each deploy, so wait a few minutes after publishing new content and reload the page.
- Your docs may not contain enough similar content for Mintlify to recommend. Automatic suggestions are drawn from the same page's language and version, so a small docs set or a lightly-populated locale can return no matches.

Check warning on line 90 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L90

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

Check warning on line 90 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L90

'lightly-populated' doesn't need a hyphen.
- End-user authentication is enabled. Curate suggestions with the `related` frontmatter field instead.

Check warning on line 91 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L91

In general, use active voice instead of passive voice ('is enabled').
- The page uses `related: false` and the section is hidden intentionally.

Check warning on line 92 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L92

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

15 changes: 15 additions & 0 deletions zh/assistant/widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,21 @@ await window.MintlifyAssistant.update({

你可以在初始化时提供 `supportEmail` 和 `starterQuestions`,也可以稍后通过 `update()` 更改。这些值仅作用于当前嵌入,不会继承自你的 Mintlify 仪表板。

<div id="authenticate-end-users">
## 对终端用户进行身份验证
</div>

向 `init()` 或 `update()` 传入已签名的 `identity` 令牌,可以将小组件会话与特定的终端用户关联。对于匿名访客,请省略 `identity`。

仅当你的部署配置了 [JWT 身份验证](/zh/deploy/authentication-setup)时,身份令牌才会被验证。请使用你在仪表板的[身份验证](https://app.mintlify.com/settings/deployment/authentication)页面上注册的同一把私钥,在你的服务器上为每个令牌签名,并包含以下声明:

- `sub`:终端用户的稳定标识符。
- `aud`:小组件 ID。
- `iat`:令牌签发时间。
- `exp`:令牌过期时间。请保持较短的有效期,并在令牌过期前通过你的后端刷新。

使用 `EdDSA` 或 `ES256` 对令牌签名。切勿泄露你的私钥,也不要在浏览器中生成令牌。

<div id="configuration-reference">
## 配置参考
</div>
Expand Down
Loading