diff --git a/api/automations/trigger.mdx b/api/automations/trigger.mdx index 33d380523..e7a71bd2f 100644 --- a/api/automations/trigger.mdx +++ b/api/automations/trigger.mdx @@ -14,9 +14,14 @@ This endpoint only supports automations configured with a **Custom schedule** tr - **Release events**: Run the **Draft changelog** automation when you cut a release tag, so the changelog drafts at the same time the release ships. - **Custom tooling**: Trigger automations from internal tools, Slack commands, or scheduled jobs you already run. -## Find the automation ID +## Find your IDs -Copy the automation ID from the automation's settings panel on the [Automations](https://app.mintlify.com/products/automations) page in your dashboard. +- **Automation ID** (`workflowSchemaId`): Copy from the automation's settings panel on the [Automations](https://app.mintlify.com/products/automations) page in your dashboard. +- **Project ID** (`projectId`): Copy from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard. + +## Check run status + +This endpoint returns as soon as the run is queued and does not wait for completion. To monitor progress, check the automation's run history on the [Automations](https://app.mintlify.com/products/automations) page in your dashboard. See [View run history](/automations/manage#view-run-history) for the statuses a run can move through. ## Example diff --git a/assistant/configure.mdx b/assistant/configure.mdx index c5353e65a..15f26a56b 100644 --- a/assistant/configure.mdx +++ b/assistant/configure.mdx @@ -57,7 +57,8 @@ Help your users begin conversations with the assistant by adding starter questio 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 Assistant** for recommended questions based on your documentation. +- **Contextual starter questions**: The assistant generates suggestions from the content of the page a user is viewing. No manual input is required. +- **Persistent starter questions**: You add up to three questions that appear on every page. Click **Ask Assistant** for recommended questions based on your documentation, then edit them to match your voice. The search suggestions panel in the dashboard with contextual starter questions enabled. diff --git a/assistant/customize.mdx b/assistant/customize.mdx index 2269c8f3b..60793e76c 100644 --- a/assistant/customize.mdx +++ b/assistant/customize.mdx @@ -14,6 +14,10 @@ Add a `.mintlify/Assistant.md` file at the root of your documentation project to Instructions in an `Assistant.md` file add to the assistant's system prompt. They do not replace or override the assistant's default instructions. +Keep instructions concise and focused. Because `Assistant.md` is included in every response, long or unfocused content can crowd out user context and dilute answers. For topic-specific guidance that should only load when relevant, use [skills](/assistant/skills) instead. + +Changes to `Assistant.md` take effect after your next deployment. To verify, open the assistant on your live site and ask a question that exercises your new instructions, such as a terminology preference or escalation path. + To remove the custom instructions, remove the `Assistant.md` file. Use `Assistant.md` to: diff --git a/assistant/skills.mdx b/assistant/skills.mdx index 5a7e29b61..07efd6519 100644 --- a/assistant/skills.mdx +++ b/assistant/skills.mdx @@ -43,10 +43,10 @@ Follow these steps to upgrade an existing v2 integration to v3. ... ``` -The assistant uses the `name` and `description` to decide when to load a skill, so write descriptions that state when the skill applies. Keep the instructions concise. The assistant truncates skill content at approximately 6,000 tokens. +The assistant uses the `name` and `description` to decide when to load a skill, so write descriptions that state when the skill applies. Keep the instructions concise. The assistant truncates skill content at approximately 6,000 tokens. Content beyond that limit is dropped from the end of the file, so put the most important guidance first and split long procedures into separate skills. - After you add or change a `skill.md` file, redeploy your site to make the skill available to the assistant. + After you add or change a `skill.md` file, redeploy your site to make the skill available to the assistant. To verify a skill loads as expected, ask the assistant a question that matches the skill's `description`. If the wrong skill loads, tighten the `description` to be more specific about when the skill applies. ## How the assistant uses skills @@ -69,4 +69,4 @@ Skills work alongside [custom assistant instructions](/assistant/customize) in ` ## Disable skills -Skills are on by default when at least one `skill.md` file is present. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your deployment, contact [support](mailto:support@mintlify.com). +Skills are on by default when at least one `skill.md` file is present. To disable a single skill, delete its directory under `.mintlify/assistant/skills/` and redeploy your site. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your deployment, contact [support](mailto:support@mintlify.com). diff --git a/automations/manage.mdx b/automations/manage.mdx index 497ccf1d0..a1fdedb13 100644 --- a/automations/manage.mdx +++ b/automations/manage.mdx @@ -112,6 +112,14 @@ You can add target languages at any time by opening the automation's settings an When you re-enable a scheduled automation or change its schedule, Mintlify recalculates the next run time from the current time. Disabled automations do not retain a pending run time. +## Delete a custom automation + +You can only delete [custom automations](/automations/create). To stop a predefined automation, disable it instead. Deleting an automation is permanent and removes its configuration and run history. + +1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard. +2. Click the settings button beside the automation. +3. Click **Delete**. + ## Run an automation manually You can trigger any enabled automation on demand without waiting for its next scheduled or event-based run. @@ -143,7 +151,7 @@ Each run shows one of the following statuses: - **Queued**: The run is waiting to start. Scheduled runs queue within 10 minutes of the scheduled time. - **In progress**: The agent is actively working on the run. - **Succeeded**: The agent finished the run. If the automation made changes, the run links to the resulting commit or pull request. -- **Failed**: The agent could not complete the run. Failed runs do not count toward your daily run limit. +- **Failed**: The agent could not complete the run. Failed runs do not count toward your daily run limit. To retry, [run the automation manually](#run-an-automation-manually) or wait for its next scheduled trigger. - **No changes**: The agent finished the run but did not find anything to update. Click an individual run to see its prompt, the files it read or changed, and any pull request it opened. diff --git a/cli/commands.mdx b/cli/commands.mdx index 1c7c515ef..c48d2b0dc 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -5,6 +5,16 @@ keywords: ["CLI", "mint", "commands", "flags", "reference"] boost: 3 --- +## Prerequisites + +The `mint` CLI requires [Node.js](https://nodejs.org) v20.17.0 or higher. Install the CLI globally with npm: + +```bash +npm i -g mint +``` + +Run commands from the root of your documentation project (the directory containing `docs.json`) unless a command explicitly accepts a path argument. See the [Quickstart](/quickstart) for a full walkthrough. + ## Global flags These flags are available on all commands. diff --git a/es/api/automations/trigger.mdx b/es/api/automations/trigger.mdx index 7a258d346..a7290a7fd 100644 --- a/es/api/automations/trigger.mdx +++ b/es/api/automations/trigger.mdx @@ -16,11 +16,18 @@ Este endpoint solo admite automatizaciones configuradas con un activador de **Pr - **Eventos de versión**: Ejecuta la automatización **Draft changelog** cuando creas una etiqueta de versión, para que el changelog se redacte al mismo tiempo que se publica la versión. - **Herramientas personalizadas**: Activa automatizaciones desde herramientas internas, comandos de Slack o tareas programadas que ya ejecutas. -
-## Encuentra el ID de la automatización +
+## Encuentra tus IDs
-Copia el ID de la automatización desde el panel de configuración de la automatización en la página [Automatizaciones](https://app.mintlify.com/products/automations) de tu dashboard. +- **ID de la automatización** (`workflowSchemaId`): Cópialo desde el panel de configuración de la automatización en la página [Automatizaciones](https://app.mintlify.com/products/automations) de tu dashboard. +- **ID del proyecto** (`projectId`): Cópialo desde la página de [API keys](https://app.mintlify.com/settings/organization/api-keys) de tu dashboard. + +
+## Consultar el estado de la ejecución +
+ +Este endpoint responde en cuanto la ejecución se pone en cola y no espera a que se complete. Para hacer seguimiento del progreso, revisa el historial de ejecuciones de la automatización en la página [Automatizaciones](https://app.mintlify.com/products/automations) de tu dashboard. Consulta [Ver el historial de ejecuciones](/es/automations/manage#view-run-history) para conocer los estados por los que puede pasar una ejecución.
## Ejemplo diff --git a/es/assistant/configure.mdx b/es/assistant/configure.mdx index 73c1f376e..9304c960a 100644 --- a/es/assistant/configure.mdx +++ b/es/assistant/configure.mdx @@ -68,7 +68,8 @@ 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 **Preguntar al asistente** para obtener preguntas recomendadas basadas en tu documentación. +- **Preguntas iniciales contextuales**: El assistant genera sugerencias a partir del contenido de la página que el usuario está viendo. No se requiere entrada manual. +- **Preguntas iniciales persistentes**: Agregas hasta tres preguntas que aparecen en cada página. Haz clic en **Preguntar al asistente** para obtener preguntas recomendadas basadas en tu documentación, luego edítalas para que coincidan con tu voz. El panel de sugerencias de búsqueda en el dashboard con preguntas iniciales contextuales habilitadas. diff --git a/es/assistant/customize.mdx b/es/assistant/customize.mdx index 1555fb6e5..3954f3fdb 100644 --- a/es/assistant/customize.mdx +++ b/es/assistant/customize.mdx @@ -14,7 +14,9 @@ Agrega un archivo `.mintlify/Assistant.md` en la raíz de tu proyecto de documen Las instrucciones en un archivo `Assistant.md` se añaden al prompt de sistema del assistant. No reemplazan ni anulan las instrucciones predeterminadas del assistant. -Para orientación profunda y específica de un tema que el assistant debería incorporar solo cuando una pregunta coincida, usa [assistant skills](/es/assistant/skills) en lugar de agregar contenido a `Assistant.md`. +Mantén las instrucciones concisas y enfocadas. Como `Assistant.md` se incluye en cada respuesta, un contenido largo o poco enfocado puede desplazar el contexto del usuario y diluir las respuestas. Para orientación específica de un tema que solo debería cargarse cuando sea relevante, usa [skills](/es/assistant/skills) en su lugar. + +Los cambios en `Assistant.md` surten efecto después de tu próximo despliegue. Para verificarlo, abre el assistant en tu sitio en vivo y haz una pregunta que ponga a prueba tus nuevas instrucciones, como una preferencia de terminología o una ruta de escalación. Para eliminar las instrucciones personalizadas, elimina el archivo `Assistant.md`. diff --git a/es/assistant/skills.mdx b/es/assistant/skills.mdx index 9c5c97894..ec58acd20 100644 --- a/es/assistant/skills.mdx +++ b/es/assistant/skills.mdx @@ -45,10 +45,10 @@ Follow these steps to upgrade an existing v2 integration to v3. ... ``` -El assistant usa `name` y `description` para decidir si carga la skill, así que escribe descripciones que indiquen claramente cuándo aplica la guía. Mantén el cuerpo enfocado: el contenido de la skill se trunca aproximadamente a 6,000 tokens cuando se carga. +El assistant usa `name` y `description` para decidir si carga la skill, así que escribe descripciones que indiquen claramente cuándo aplica la guía. Mantén el cuerpo enfocado: el contenido de la skill se trunca aproximadamente a 6,000 tokens cuando se carga. El contenido que excede ese límite se descarta desde el final del archivo, así que coloca primero la orientación más importante y divide los procedimientos largos en skills separadas. - Las skills se descubren en tu próxima actualización de documentación. Después de agregar o cambiar un archivo `skill.md`, publica tus docs para que la skill esté disponible para el assistant. + Después de agregar o cambiar un archivo `skill.md`, vuelve a desplegar tu sitio para que la skill esté disponible para el assistant. Para verificar que una skill se cargue como esperas, hazle al assistant una pregunta que coincida con la `description` de la skill. Si se carga la skill equivocada, ajusta la `description` para que sea más específica sobre cuándo aplica la skill.
@@ -77,4 +77,4 @@ Las skills funcionan junto con las [instrucciones personalizadas del assistant]( ## Deshabilitar skills
-Las skills están activadas de forma predeterminada cuando hay al menos un archivo `skill.md` presente. Para desactivar las skills por completo en tu deployment, contacta a [soporte](mailto:support@mintlify.com) para deshabilitar la función de assistant skills. Eliminar el directorio `.mintlify/assistant/skills/` y volver a publicar también limpia el catálogo. +Las skills están activadas de forma predeterminada cuando hay al menos un archivo `skill.md` presente. Para deshabilitar una única skill, elimina su directorio dentro de `.mintlify/assistant/skills/` y vuelve a desplegar tu sitio. Para eliminar todas las skills, elimina el directorio `.mintlify/assistant/skills/` y vuelve a desplegar tu sitio. Para desactivar la función de skills en tu deployment, contacta a [soporte](mailto:support@mintlify.com). diff --git a/es/automations/manage.mdx b/es/automations/manage.mdx index d1dfdf47f..5c578cfed 100644 --- a/es/automations/manage.mdx +++ b/es/automations/manage.mdx @@ -134,6 +134,16 @@ Puedes añadir idiomas de destino en cualquier momento abriendo la configuració Cuando vuelves a activar una automatización programada o cambias su programación, Mintlify recalcula el próximo tiempo de ejecución a partir de la hora actual. Las automatizaciones desactivadas no conservan un tiempo de ejecución pendiente. +
+## Eliminar una automatización personalizada +
+ +Solo puedes eliminar [automatizaciones personalizadas](/es/automations/create). Para detener una automatización predefinida, desactívala en su lugar. Eliminar una automatización es permanente y elimina su configuración y su historial de ejecuciones. + +1. Abre la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard. +2. Haz clic en el botón de configuración junto a la automatización. +3. Haz clic en **Delete**. +
## Ejecutar una automatización manualmente
@@ -171,7 +181,7 @@ Cada ejecución muestra uno de los siguientes estados: - **Queued**: La ejecución está esperando para comenzar. Las ejecuciones programadas se ponen en cola dentro de los 10 minutos siguientes a la hora programada. - **In progress**: El agente está trabajando activamente en la ejecución. - **Succeeded**: El agente finalizó la ejecución. Si la automatización realizó cambios, la ejecución enlaza con el commit o la pull request resultante. -- **Failed**: El agente no pudo completar la ejecución. Las ejecuciones fallidas no cuentan para tu límite diario de ejecuciones. +- **Failed**: El agente no pudo completar la ejecución. Las ejecuciones fallidas no cuentan para tu límite diario de ejecuciones. Para reintentar, [ejecuta la automatización manualmente](#run-an-automation-manually) o espera a su próximo activador programado. - **No changes**: El agente finalizó la ejecución pero no encontró nada que actualizar. Haz clic en una ejecución individual para ver su prompt, los archivos que leyó o modificó y cualquier pull request que haya abierto. diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index 4e68b7e81..0849fa2f2 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -5,6 +5,18 @@ keywords: ["CLI", "mint", "comandos", "flags", "referencia"] boost: 3 --- +
+ ## Requisitos previos +
+ +La CLI `mint` requiere [Node.js](https://nodejs.org) v20.17.0 o superior. Instala la CLI de forma global con npm: + +```bash +npm i -g mint +``` + +Ejecuta los comandos desde la raíz de tu proyecto de documentación (el directorio que contiene `docs.json`) a menos que un comando acepte explícitamente un argumento de ruta. Consulta la [Quickstart](/es/quickstart) para ver un recorrido completo. +
## Flags globales
diff --git a/es/organize/settings-reference.mdx b/es/organize/settings-reference.mdx index e8e9ec91a..f67849a8f 100644 --- a/es/organize/settings-reference.mdx +++ b/es/organize/settings-reference.mdx @@ -6,6 +6,12 @@ keywords: ["docs.json", "schema", "reference", "configuration", "all settings", Los campos obligatorios tienen una insignia required. Todos los demás campos son opcionales. +Tu archivo `docs.json` reside en la raíz de tu repositorio de documentación. Consulta [Configuración global](/es/organize/settings) para conocer los fundamentos de la configuración. + + + Agrega `"$schema": "https://mintlify.com/docs.json"` al principio de tu `docs.json` para obtener autocompletado y validación en editores como VS Code. Para validar `docs.json` localmente, ejecuta [`mint dev`](/es/cli/commands#mint-dev) o [`mint validate`](/es/cli/commands#mint-validate) desde la raíz de tu proyecto: los errores de esquema aparecen al iniciar. + + Para obtener contexto sobre lo que hace cada grupo de ajustes, consulta las páginas de temas: * [Apariencia y marca](/es/organize/settings-appearance) diff --git a/fr/api/automations/trigger.mdx b/fr/api/automations/trigger.mdx index fb0acdd2c..962e1e320 100644 --- a/fr/api/automations/trigger.mdx +++ b/fr/api/automations/trigger.mdx @@ -16,11 +16,18 @@ Cet endpoint ne prend en charge que les automatisations configurées avec un dé - **Événements de version** : Exécutez l'automatisation **Draft changelog** lorsque vous créez un tag de version, afin que le changelog soit rédigé au moment même où la version est publiée. - **Outillage personnalisé** : Déclenchez des automatisations depuis vos outils internes, des commandes Slack ou des tâches planifiées que vous exécutez déjà. -
- ## Trouver l'identifiant de l'automatisation +
+ ## Trouver vos identifiants
-Copiez l'identifiant de l'automatisation depuis le panneau de paramètres de l'automatisation sur la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard. +- **Identifiant d'automatisation** (`workflowSchemaId`) : Copiez-le depuis le panneau de paramètres de l'automatisation sur la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard. +- **Identifiant de projet** (`projectId`) : Copiez-le depuis la page [API keys](https://app.mintlify.com/settings/organization/api-keys) de votre dashboard. + +
+ ## Vérifier le statut de l'exécution +
+ +Cet endpoint renvoie une réponse dès que l'exécution est mise en file d'attente et n'attend pas la fin de celle-ci. Pour suivre son avancement, consultez l'historique des exécutions de l'automatisation sur la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard. Consultez [Consulter l'historique des exécutions](/fr/automations/manage#view-run-history) pour connaître les statuts par lesquels une exécution peut passer.
## Exemple diff --git a/fr/assistant/configure.mdx b/fr/assistant/configure.mdx index b768a10ea..6591b9a21 100644 --- a/fr/assistant/configure.mdx +++ b/fr/assistant/configure.mdx @@ -68,7 +68,8 @@ 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 **Demander à l'assistant** pour obtenir des questions recommandées basées sur votre documentation. +- **Questions de démarrage contextuelles** : L'assistant génère des suggestions à partir du contenu de la page consultée par l'utilisateur. Aucune saisie manuelle n'est requise. +- **Questions de démarrage persistantes** : Vous ajoutez jusqu'à trois questions qui apparaissent sur toutes les pages. Cliquez sur **Ask Assistant** pour obtenir des questions recommandées basées sur votre documentation, puis modifiez-les pour qu'elles correspondent à votre ton. Le panneau de suggestions de recherche dans le tableau de bord avec les questions de démarrage contextuelles activées. diff --git a/fr/assistant/customize.mdx b/fr/assistant/customize.mdx index ab4611d1c..debfaad7d 100644 --- a/fr/assistant/customize.mdx +++ b/fr/assistant/customize.mdx @@ -14,10 +14,14 @@ Ajoutez un fichier `.mintlify/Assistant.md` à la racine de votre projet de docu Les instructions dans un fichier `Assistant.md` s'ajoutent au prompt système de l'assistant. Elles ne remplacent ni ne substituent les instructions par défaut de l'assistant. -Pour des conseils approfondis et spécifiques à un sujet que l'assistant ne doit charger que lorsqu'une question correspond, utilisez les [skills de l'assistant](/fr/assistant/skills) plutôt que d'ajouter du contenu à `Assistant.md`. +Gardez vos instructions concises et ciblées. Comme `Assistant.md` est inclus dans chaque réponse, un contenu long ou peu ciblé peut prendre la place du contexte utilisateur et diluer les réponses. Pour des conseils spécifiques à un sujet qui ne doivent se charger que lorsqu'ils sont pertinents, utilisez plutôt les [skills](/fr/assistant/skills). + +Les modifications apportées à `Assistant.md` prennent effet après votre prochain déploiement. Pour vérifier, ouvrez l'assistant sur votre site en production et posez une question qui met en jeu vos nouvelles instructions, comme une préférence terminologique ou un chemin d'escalade. Pour supprimer les instructions personnalisées, supprimez le fichier `Assistant.md`. +Pour des conseils approfondis et spécifiques à un sujet que l'assistant ne doit charger que lorsqu'une question correspond, utilisez les [skills de l'assistant](/fr/assistant/skills) plutôt que d'ajouter du contenu à `Assistant.md`. + Utilisez `Assistant.md` pour : - Ajuster la personnalité et le ton de l'assistant diff --git a/fr/assistant/skills.mdx b/fr/assistant/skills.mdx index 70d93cb57..c389b35c2 100644 --- a/fr/assistant/skills.mdx +++ b/fr/assistant/skills.mdx @@ -45,10 +45,10 @@ Follow these steps to upgrade an existing v2 integration to v3. ... ``` -L'assistant utilise `name` et `description` pour décider s'il doit charger la skill. Rédigez donc des descriptions qui indiquent clairement quand le guide s'applique. Gardez le corps concentré : le contenu d'une skill est tronqué à environ 6 000 tokens lors du chargement. +L'assistant utilise `name` et `description` pour décider s'il doit charger la skill. Rédigez donc des descriptions qui indiquent clairement quand le guide s'applique. Gardez le corps concentré : le contenu d'une skill est tronqué à environ 6 000 tokens lors du chargement. Le contenu au-delà de cette limite est supprimé depuis la fin du fichier ; placez donc les conseils les plus importants en premier et découpez les procédures longues en plusieurs skills. - Les skills sont découvertes lors de votre prochaine mise à jour de la documentation. Après avoir ajouté ou modifié un fichier `skill.md`, publiez votre documentation pour rendre la skill disponible à l'assistant. + Les skills sont découvertes lors de votre prochaine mise à jour de la documentation. Après avoir ajouté ou modifié un fichier `skill.md`, publiez votre documentation pour rendre la skill disponible à l'assistant. Pour vérifier qu'une skill se charge comme prévu, posez à l'assistant une question qui correspond à la `description` de la skill. Si la mauvaise skill se charge, précisez la `description` pour indiquer plus clairement quand la skill s'applique.
@@ -77,4 +77,4 @@ Les skills fonctionnent en complément des [instructions personnalisées de l'as ## Désactiver les skills
-Les skills sont activées par défaut lorsqu'au moins un fichier `skill.md` est présent. Pour désactiver entièrement les skills pour votre déploiement, contactez le [support](mailto:support@mintlify.com) afin de désactiver la fonctionnalité des skills de l'assistant. Supprimer le répertoire `.mintlify/assistant/skills/` et republier vide également le catalogue. +Les skills sont activées par défaut lorsqu'au moins un fichier `skill.md` est présent. Pour désactiver une seule skill, supprimez son répertoire sous `.mintlify/assistant/skills/` et republiez votre site. Pour supprimer toutes les skills, supprimez le répertoire `.mintlify/assistant/skills/` et republiez votre site. Pour désactiver entièrement la fonctionnalité des skills pour votre déploiement, contactez le [support](mailto:support@mintlify.com). diff --git a/fr/automations/manage.mdx b/fr/automations/manage.mdx index a25887854..34d9db687 100644 --- a/fr/automations/manage.mdx +++ b/fr/automations/manage.mdx @@ -134,6 +134,16 @@ Vous pouvez ajouter des langues cibles à tout moment en ouvrant les paramètres Lorsque vous réactivez une automatisation planifiée ou modifiez son calendrier, Mintlify recalcule la prochaine heure d'exécution à partir de l'heure actuelle. Les automatisations désactivées ne conservent pas d'heure d'exécution en attente. +
+ ## Supprimer une automatisation personnalisée +
+ +Vous ne pouvez supprimer que les [automatisations personnalisées](/fr/automations/create). Pour arrêter une automatisation prédéfinie, désactivez-la à la place. La suppression d'une automatisation est définitive et retire sa configuration ainsi que son historique d'exécutions. + +1. Ouvrez la page [Automations](https://app.mintlify.com/products/automations) dans votre dashboard. +2. Cliquez sur le bouton de paramètres à côté de l'automatisation. +3. Cliquez sur **Delete**. +
## Exécuter une automatisation manuellement
@@ -171,7 +181,7 @@ Chaque exécution affiche l'un des statuts suivants : - **Queued** : l'exécution est en attente de démarrage. Les exécutions planifiées sont mises en file d'attente dans les 10 minutes suivant l'heure planifiée. - **In progress** : l'agent travaille activement sur l'exécution. - **Succeeded** : l'agent a terminé l'exécution. Si l'automatisation a effectué des modifications, l'exécution renvoie vers le commit ou la pull request qui en résulte. -- **Failed** : l'agent n'a pas pu terminer l'exécution. Les exécutions en échec ne comptent pas dans votre limite quotidienne d'exécutions. +- **Failed** : l'agent n'a pas pu terminer l'exécution. Les exécutions en échec ne comptent pas dans votre limite quotidienne d'exécutions. Pour réessayer, [exécutez l'automatisation manuellement](#run-an-automation-manually) ou attendez son prochain déclenchement planifié. - **No changes** : l'agent a terminé l'exécution mais n'a rien trouvé à mettre à jour. Cliquez sur une exécution individuelle pour voir son prompt, les fichiers qu'elle a lus ou modifiés, et toute pull request qu'elle a ouverte. diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index 2faf3ccfd..c966b7617 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -5,6 +5,18 @@ keywords: ["CLI", "mint", "commandes", "flags", "référence"] boost: 3 --- +
+ ## Prérequis +
+ +La CLI `mint` nécessite [Node.js](https://nodejs.org) v20.17.0 ou une version supérieure. Installez la CLI globalement avec npm : + +```bash +npm i -g mint +``` + +Exécutez les commandes depuis la racine de votre projet de documentation (le répertoire contenant `docs.json`), sauf si une commande accepte explicitement un argument de chemin. Consultez le [Guide de démarrage rapide](/fr/quickstart) pour un tutoriel complet. +
## Flags globaux
diff --git a/fr/organize/settings-reference.mdx b/fr/organize/settings-reference.mdx index 29a813ac3..825faa0f9 100644 --- a/fr/organize/settings-reference.mdx +++ b/fr/organize/settings-reference.mdx @@ -6,6 +6,12 @@ keywords: ["docs.json", "schema", "reference", "configuration", "all settings", Les champs requis ont un badge required. Tous les autres champs sont facultatifs. +Votre fichier `docs.json` se trouve à la racine de votre dépôt de documentation. Consultez [Paramètres globaux](/fr/organize/settings) pour les bases de la configuration. + + + Ajoutez `"$schema": "https://mintlify.com/docs.json"` en haut de votre `docs.json` pour bénéficier de l'autocomplétion et de la validation dans des éditeurs comme VS Code. Pour valider `docs.json` localement, exécutez [`mint dev`](/fr/cli/commands#mint-dev) ou [`mint validate`](/fr/cli/commands#mint-validate) depuis la racine de votre projet — les erreurs de schéma apparaissent au démarrage. + + Pour comprendre ce que fait chaque groupe de paramètres, consultez les pages thématiques : * [Apparence et identité visuelle](/fr/organize/settings-appearance) diff --git a/organize/settings-reference.mdx b/organize/settings-reference.mdx index e23861c15..d53060e1a 100644 --- a/organize/settings-reference.mdx +++ b/organize/settings-reference.mdx @@ -6,6 +6,12 @@ keywords: ["docs.json", "schema", "reference", "configuration", "all settings", Required fields have a required badge. All other fields are optional. +Your `docs.json` file lives at the root of your docs repository. See [Global settings](/organize/settings) for setup basics. + + + Add `"$schema": "https://mintlify.com/docs.json"` to the top of your `docs.json` for autocomplete and validation in editors like VS Code. To validate `docs.json` locally, run [`mint dev`](/cli/commands#mint-dev) or [`mint validate`](/cli/commands#mint-validate) from your project root—schema errors surface at startup. + + For context on what each group of settings does, see the topic pages: * [Appearance and branding](/organize/settings-appearance) diff --git a/zh/api/automations/trigger.mdx b/zh/api/automations/trigger.mdx index 4f698940f..bd2eea8af 100644 --- a/zh/api/automations/trigger.mdx +++ b/zh/api/automations/trigger.mdx @@ -16,11 +16,18 @@ keywords: ["automation", "workflow", "trigger", "webhook", "schedule", "CI"] - **发布事件**:在你打出发布标签时运行 **Draft changelog** 自动化,使变更日志与发布同时起草。 - **自定义工具**:从内部工具、Slack 命令或已有的计划任务中触发自动化。 -
- ## 查找自动化 ID +
+ ## 查找你的 ID
-在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面,从自动化的设置面板中复制自动化 ID。 +- **Automation ID**(`workflowSchemaId`):在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面,从自动化的设置面板中复制。 +- **Project ID**(`projectId`):在控制台的 [API keys](https://app.mintlify.com/settings/organization/api-keys) 页面复制。 + +
+ ## 查看运行状态 +
+ +此端点会在运行进入队列后立即返回,不会等待运行完成。要监控进度,请在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面查看自动化的运行历史。有关运行可能经历的状态,请参见[查看运行历史](/zh/automations/manage#view-run-history)。
## 示例 diff --git a/zh/assistant/configure.mdx b/zh/assistant/configure.mdx index bba0f1b5b..5a082842e 100644 --- a/zh/assistant/configure.mdx +++ b/zh/assistant/configure.mdx @@ -68,7 +68,8 @@ keywords: ["assistant", "设置", "转接", "机器人防护", "计费"] AI 助手可以根据用户正在查看的页面生成特定于页面的问题,你也可以添加在所有页面上都可用的固定问题。 -你最多可以添加三个示例问题。点击 **询问助手** 获取基于你文档的推荐问题。 +- **上下文相关的示例问题**:AI 助手根据用户正在查看的页面内容生成建议问题,无需手动输入。 +- **固定的示例问题**:你最多可以添加三个在每个页面上都会显示的问题。点击 **Ask Assistant** 获取基于你文档的推荐问题,然后编辑它们以符合你的风格。 仪表盘中的搜索建议面板,已启用上下文相关的示例问题。 diff --git a/zh/assistant/customize.mdx b/zh/assistant/customize.mdx index 718c65204..60b358fa0 100644 --- a/zh/assistant/customize.mdx +++ b/zh/assistant/customize.mdx @@ -14,6 +14,10 @@ keywords: ["assistant", "自定义指令", "Assistant.md", "系统提示", "角 `Assistant.md` 文件中的指令会添加到 AI 助手的系统提示中。它们不会替换或覆盖 AI 助手的默认指令。 +请让指令保持简洁并聚焦。因为 `Assistant.md` 会包含在每次响应中,冗长或散乱的内容会挤占用户上下文并稀释回答质量。对于仅在相关时才需要加载的、面向特定主题的指导,请改用 [skills](/zh/assistant/skills)。 + +对 `Assistant.md` 的更改会在下一次部署后生效。要验证效果,请在你的线上站点打开 AI 助手,提出能触发新指令的问题,例如术语偏好或升级路径。 + 对于 AI 助手仅在问题匹配时才应引入的、面向特定主题的深入指导,请使用 [assistant skills](/zh/assistant/skills),而不是将内容加入 `Assistant.md`。 要删除自定义指令,请删除 `Assistant.md` 文件。 diff --git a/zh/assistant/skills.mdx b/zh/assistant/skills.mdx index ac56fbfbd..4e4a045bb 100644 --- a/zh/assistant/skills.mdx +++ b/zh/assistant/skills.mdx @@ -45,10 +45,10 @@ Follow these steps to upgrade an existing v2 integration to v3. ... ``` -AI 助手会依据 `name` 和 `description` 来决定是否加载该 skill,因此描述应清楚说明该指南何时适用。请让正文保持聚焦:加载时 skill 内容会在约 6,000 tokens 处被截断。 +AI 助手会依据 `name` 和 `description` 来决定是否加载该 skill,因此描述应清楚说明该指南何时适用。请让正文保持聚焦:加载时 skill 内容会在约 6,000 tokens 处被截断。超出该限制的内容会从文件末尾开始被丢弃,因此请把最重要的指导放在前面,并将过长的流程拆分为多个 skill。 - Skills 会在你下一次文档更新时被发现。添加或修改 `skill.md` 文件后,请发布文档以让 AI 助手能够使用该 skill。 + Skills 会在你下一次文档更新时被发现。添加或修改 `skill.md` 文件后,请发布文档以让 AI 助手能够使用该 skill。要验证 skill 是否按预期加载,请向 AI 助手提出与该 skill `description` 匹配的问题。如果加载了错误的 skill,请收紧 `description`,更明确地说明该 skill 适用的场景。
@@ -77,4 +77,4 @@ Skills 与 `.mintlify/Assistant.md` 中的[自定义 AI 助手指令](/zh/assist ## 禁用 skills
-当至少存在一个 `skill.md` 文件时,skills 会默认启用。若要完全关闭部署中的 skills 功能,请联系[技术支持](mailto:support@mintlify.com)以禁用 assistant skills 功能。移除 `.mintlify/assistant/skills/` 目录并重新发布也会清空目录列表。 +当至少存在一个 `skill.md` 文件时,skills 会默认启用。要禁用单个 skill,请删除其在 `.mintlify/assistant/skills/` 下对应的目录,并重新发布你的站点。要移除所有 skills,请删除 `.mintlify/assistant/skills/` 目录并重新发布你的站点。若要完全关闭部署中的 skills 功能,请联系[技术支持](mailto:support@mintlify.com)。 diff --git a/zh/automations/manage.mdx b/zh/automations/manage.mdx index f547f2311..11e67d993 100644 --- a/zh/automations/manage.mdx +++ b/zh/automations/manage.mdx @@ -134,6 +134,16 @@ import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; 当你重新启用一个计划自动化或更改其计划时,Mintlify 会从当前时间重新计算下次运行时间。已禁用的自动化不会保留待运行时间。 +
+ ## 删除自定义自动化 +
+ +你只能删除[自定义自动化](/zh/automations/create)。要停止预定义自动化,请改为禁用它。删除自动化是永久性的,会移除其配置和运行历史。 + +1. 在控制台中打开 [Automations](https://app.mintlify.com/products/automations) 页面。 +2. 点击自动化旁边的 设置按钮。 +3. 点击 **Delete**。 +
## 手动运行自动化
@@ -171,7 +181,7 @@ import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; - **Queued**:运行正在等待开始。计划运行会在预定时间的 10 分钟内进入队列。 - **In progress**:agent 正在执行该运行。 - **Succeeded**:agent 已完成运行。如果自动化做了更改,运行会链接到生成的 commit 或 pull request。 -- **Failed**:agent 无法完成运行。失败的运行不会计入每日运行限制。 +- **Failed**:agent 无法完成运行。失败的运行不会计入每日运行限制。若要重试,请[手动运行自动化](#run-an-automation-manually)或等待其下一次计划触发。 - **No changes**:agent 完成了运行,但未发现需要更新的内容。 点击单次运行即可查看其提示词、读取或更改的文件,以及它打开的任何 pull request。 diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index a6045059d..26807db35 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -5,6 +5,18 @@ keywords: ["CLI", "mint", "命令", "选项", "参考"] boost: 3 --- +
+ ## 前置条件 +
+ +`mint` CLI 需要 [Node.js](https://nodejs.org) v20.17.0 或更高版本。使用 npm 全局安装 CLI: + +```bash +npm i -g mint +``` + +除非命令明确接受路径参数,否则请从文档项目的根目录(即包含 `docs.json` 的目录)运行命令。完整流程请参见[快速开始](/zh/quickstart)。 +
## 全局选项
diff --git a/zh/organize/settings-reference.mdx b/zh/organize/settings-reference.mdx index 77e42a35e..8c4a10d7a 100644 --- a/zh/organize/settings-reference.mdx +++ b/zh/organize/settings-reference.mdx @@ -6,6 +6,12 @@ keywords: ["docs.json", "schema", "参考", "配置", "所有设置", "属性", 必需字段有 必需 标记。所有其他字段都是可选的。 +你的 `docs.json` 文件位于文档仓库的根目录。基本设置说明请参见[全局设置](/zh/organize/settings)。 + + + 在 `docs.json` 顶部添加 `"$schema": "https://mintlify.com/docs.json"`,可在 VS Code 等编辑器中启用自动补全和校验。要在本地校验 `docs.json`,请在项目根目录运行 [`mint dev`](/zh/cli/commands#mint-dev) 或 [`mint validate`](/zh/cli/commands#mint-validate)—— schema 错误会在启动时显示。 + + 有关每组设置的功能说明,请参阅主题页面: * [外观与品牌](/zh/organize/settings-appearance)