diff --git a/docs.json b/docs.json index 262877130..415da2c1e 100644 --- a/docs.json +++ b/docs.json @@ -565,7 +565,7 @@ "tab": "Référence de l’API", "groups": [ { - "group": "Référence de l'API", + "group": "Référence de l’API", "icon": "file-json", "pages": [ "fr/api/introduction" diff --git a/es/api/agent/create-agent-job.mdx b/es/api/agent/create-agent-job.mdx index 21450b9b5..750a24a4d 100644 --- a/es/api/agent/create-agent-job.mdx +++ b/es/api/agent/create-agent-job.mdx @@ -2,12 +2,12 @@ openapi: POST /agent/{projectId}/job --- -Este endpoint crea un job de agente a partir de los mensajes proporcionados y la información de la branch. El job se ejecuta de forma asíncrona y devuelve una respuesta en streaming con los detalles de ejecución y los resultados. +Este endpoint crea un trabajo de agente a partir de los mensajes proporcionados y la información de la branch. El trabajo se ejecuta de forma asíncrona y devuelve una respuesta en streaming con los detalles de la ejecución y los resultados. -Si no existe una branch, el agente crea una. Si los archivos se editan correctamente, al final del job se crea automáticamente una solicitud de extracción en borrador. +Si no existe una branch, el agente crea una. Si los archivos se editan correctamente, al final del trabajo se crea automáticamente una solicitud de extracción en borrador.
- ## Límites de velocidad + ## Límites de tasa
La API del agente tiene los siguientes límites: @@ -18,4 +18,4 @@ La API del agente tiene los siguientes límites: ## Uso recomendado -Para obtener los mejores resultados, utiliza el [hook useChat de ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) para enviar solicitudes y gestionar respuestas. \ No newline at end of file +Para obtener mejores resultados, utiliza el [hook useChat de ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) para enviar solicitudes y gestionar las respuestas. \ No newline at end of file diff --git a/es/api/agent/get-agent-job.mdx b/es/api/agent/get-agent-job.mdx index 4e688fe16..d1724aa5a 100644 --- a/es/api/agent/get-agent-job.mdx +++ b/es/api/agent/get-agent-job.mdx @@ -6,7 +6,7 @@ openapi: GET /agent/{projectId}/job/{id} ## Uso -Este endpoint obtiene los detalles y el estado de un trabajo de agente específico mediante su identificador único. Úsalo para consultar el progreso, el estado y los resultados de un trabajo de agente creado previamente. +Este endpoint obtiene los detalles y el estado de un trabajo de agente específico mediante su identificador único. Úsalo para comprobar el progreso, el estado y los resultados de un trabajo de agente creado previamente.
## Detalles del trabajo @@ -14,6 +14,6 @@ Este endpoint obtiene los detalles y el estado de un trabajo de agente específi La respuesta incluye información como: -- Estado de ejecución y de finalización del trabajo +- Estado de ejecución del trabajo y estado de finalización - Información de la branch y detalles de la solicitud de extracción - metadata de la sesión y marcas de tiempo \ No newline at end of file diff --git a/es/api/agent/get-all-jobs.mdx b/es/api/agent/get-all-jobs.mdx index 3911972f2..cc85a165e 100644 --- a/es/api/agent/get-all-jobs.mdx +++ b/es/api/agent/get-all-jobs.mdx @@ -6,10 +6,10 @@ openapi: GET /agent/{projectId}/jobs ## Uso
-Este endpoint obtiene todos los trabajos del agente para el domain especificado, y ofrece una visión general de las actividades del agente y su estado actual. Es útil para supervisar y gestionar múltiples trabajos del agente, ya sean concurrentes o históricos. +Este endpoint obtiene todos los trabajos del agente para el domain especificado, ofreciendo una visión general de todas las actividades del agente y su estado actual. Es útil para supervisar y gestionar múltiples trabajos del agente, tanto concurrentes como históricos.
## Respuesta
-Usa este endpoint para obtener una visión completa de todas las sesiones previas del agente. \ No newline at end of file +Utilice este endpoint para obtener una vista completa de todas las sesiones anteriores del agente. \ No newline at end of file diff --git a/es/api/assistant/create-assistant-message.mdx b/es/api/assistant/create-assistant-message.mdx index ca8cff410..5d217f14f 100644 --- a/es/api/assistant/create-assistant-message.mdx +++ b/es/api/assistant/create-assistant-message.mdx @@ -2,8 +2,6 @@ openapi: POST /assistant/{domain}/message --- - -
## Límites de uso
@@ -14,12 +12,10 @@ La API del assistant tiene los siguientes límites: - 10,000 solicitudes por organización de Mintlify por hora - 10,000 solicitudes por IP al día - -
## Uso recomendado
-Para obtener mejores resultados, usa el [hook useChat de ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) para enviar solicitudes y gestionar respuestas. +Para obtener mejores resultados, utiliza el [hook useChat de ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) para enviar solicitudes y manejar las respuestas. -Puedes establecer `fp`, `threadId` y `filter` en el campo `body` del parámetro de opciones que se pasa al hook. \ No newline at end of file +Puedes configurar `fp`, `threadId` y `filter` en el campo `body` del parámetro de opciones pasado al hook. \ No newline at end of file diff --git a/es/api/assistant/create-topic.mdx b/es/api/assistant/create-topic.mdx index dc00663e3..30ad8b74f 100644 --- a/es/api/assistant/create-topic.mdx +++ b/es/api/assistant/create-topic.mdx @@ -1,3 +1,3 @@ --- openapi: POST /chat/topic ---- +--- \ No newline at end of file diff --git a/es/api/assistant/generate-message.mdx b/es/api/assistant/generate-message.mdx index b1cdbbb37..30a74c542 100644 --- a/es/api/assistant/generate-message.mdx +++ b/es/api/assistant/generate-message.mdx @@ -1,3 +1,3 @@ --- openapi: POST /chat/message ---- +--- \ No newline at end of file diff --git a/es/api/assistant/search.mdx b/es/api/assistant/search.mdx index aad5f0e85..d0c97a8da 100644 --- a/es/api/assistant/search.mdx +++ b/es/api/assistant/search.mdx @@ -1,3 +1,3 @@ --- openapi: "POST /search/{domain}" ---- +--- \ No newline at end of file diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx index 8746be6c9..5f4dffcfc 100644 --- a/es/api/introduction.mdx +++ b/es/api/introduction.mdx @@ -1,16 +1,16 @@ --- title: "Introducción" -description: "Activar actualizaciones, integrar el assistant de IA y más" +description: "Activar actualizaciones, incrustar el assistant de IA y más" --- -La API REST de Mintlify te permite interactuar con tu documentación de forma programática, activar actualizaciones e integrar experiencias de chat con IA. +La API REST de Mintlify te permite interactuar con tu documentación de forma programática, activar actualizaciones e incrustar experiencias de chat con IA.
## Endpoints
* [Trigger update](/es/api-reference/update/trigger): Activa una actualización de tu sitio cuando lo desees. -* [Get update status](/es/api-reference/update/status): Obtén el estado de una actualización y otros detalles sobre tu documentación. +* [Get update status](/es/api-reference/update/status): Obtén el estado de una actualización y otros detalles de tu documentación. * [Create agent job](/es/api-reference/agent/create-agent-job): Crea un trabajo de agente para editar tu documentación automáticamente. * [Get agent job](/es/api-reference/agent/get-agent-job): Obtén los detalles y el estado de un trabajo de agente específico. * [Get all agent jobs](/es/api-reference/agent/get-all-jobs): Obtén todos los trabajos de agente para un domain. @@ -21,28 +21,28 @@ La API REST de Mintlify te permite interactuar con tu documentación de forma pr ## Autenticación -Puedes generar una API key desde el [dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). Las API keys están asociadas a toda la organización y pueden usarse en varias implementaciones. +Puedes generar una API key desde [el dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). Las API keys están asociadas a toda la organización y se pueden usar en múltiples implementaciones.
- ### Clave de API de administrador + ### Clave de la API de administrador
-La clave de API de administrador se utiliza para [Trigger update](/es/api-reference/update/trigger), [Get update status](/es/api-reference/update/status) y todos los endpoints de agentes. +La clave de la API de administrador se utiliza para [Activar actualización](/es/api-reference/update/trigger), [Obtener estado de la actualización](/es/api-reference/update/status) y todos los endpoints del agente. -Las claves de API de administrador comienzan con el prefijo `mint_`. Mantén en secreto tus claves de API de administrador. +Las claves de la API de administrador comienzan con el prefijo `mint_`. Mantén en secreto tus claves de la API de administrador.
- ### Clave de la API del assistant + ### key del Assistant API
-La clave de la API del assistant se usa en los endpoints [Generate assistant message](/es/api-reference/assistant/create-assistant-message) y [Search documentation](/es/api-reference/assistant/search). +La key del Assistant API se usa en los endpoints [Generate assistant message](/es/api-reference/assistant/create-assistant-message) y [Search documentation](/es/api-reference/assistant/search). -Las claves de la API del assistant comienzan con el prefijo `mint_dsc_`. +Las keys del Assistant API comienzan con el prefijo `mint_dsc_`. -La **key** de la API del assistant es un token del lado del servidor que debe mantenerse en secreto. +La **key** del Assistant API es un token del lado del servidor que debe mantenerse en secreto. -El **token** de la API del assistant es un token público que puede referenciarse en tu código de frontend. +El **token** del Assistant API es un token público que puede referenciarse en tu código de frontend. - Las llamadas que usan el token de la API del assistant pueden generar costos: ya sea usando tus créditos del Asistente de IA o incurriendo en sobrecargos. + Las llamadas que usan el token del Assistant API pueden generar costos: ya sea usando tus créditos del Asistente de IA o incurriendo en excedentes. \ No newline at end of file diff --git a/es/api/update/status.mdx b/es/api/update/status.mdx index 9e2e93b66..1ea0b419a 100644 --- a/es/api/update/status.mdx +++ b/es/api/update/status.mdx @@ -1,3 +1,3 @@ --- openapi: "GET /project/update-status/{statusId}" ---- +--- \ No newline at end of file diff --git a/es/api/update/trigger.mdx b/es/api/update/trigger.mdx index 26b0968f3..e4d85f180 100644 --- a/es/api/update/trigger.mdx +++ b/es/api/update/trigger.mdx @@ -1,3 +1,3 @@ --- openapi: "POST /project/update/{projectId}" ---- +--- \ No newline at end of file diff --git a/es/changelog.mdx b/es/changelog.mdx index 69c36a1e4..36c6e3dbd 100644 --- a/es/changelog.mdx +++ b/es/changelog.mdx @@ -5,91 +5,132 @@ rss: true noindex: true --- - - ## Ampliación del soporte de idiomas + + ## Nuevas funciones - * Se agregó soporte para rumano y checo en la interfaz de la documentación - * Se mejoraron las capacidades de localización con cobertura de traducción completa para los nuevos idiomas - * Se mejoró la funcionalidad del selector de idioma en todos los temas + * **Navegación de productos**: Organiza la documentación de varios productos con el conmutador de productos en la navegación + * **Comando de CLI de accesibilidad**: Ejecuta `mint a11y` para probar tu documentación en busca de problemas de accesibilidad + * **Respuestas de video en el área de pruebas de la API**: El área de pruebas de la API ahora admite la visualización de tipos de respuesta en video + * **Autorrelleno del área de pruebas de la API**: Nueva opción para prellenar ejemplos del área de pruebas de la API y acelerar las pruebas + * **Comentarios sin autenticación**: En sitios con autenticación parcial, los usuarios ahora pueden enviar comentarios sin estar autenticados + * **Compatibilidad con temas de Shiki**: Ahora se admiten temas de Shiki para el estilo de los bloques de código + * **Twoslash para bloques de código**: Los bloques de código de TypeScript y JavaScript ahora admiten Twoslash para información de tipos en línea - ## Mejoras de la interfaz y experiencia de usuario + ## Mejoras de accesibilidad - * Se corrigieron problemas de visibilidad de tabs en páginas 404 para evitar el resaltado incorrecto del tab activo - * Se mejoró el manejo de imágenes pasando correctamente los atributos width y height en imágenes no optimizadas - * Se mejoró el diseño y la consistencia de estilos de la página 404 + * Se agregaron atributos ARIA completos en todos los componentes para un mejor soporte de lectores de pantalla + * Nuevo botón "saltar al contenido principal" para la navegación con teclado + * Compatibilidad con navegación mediante teclas de flecha en componentes de pestañas + * Mejoras en los tooltips, las listas anidadas y la accesibilidad de los grupos de código + * Estados de foco e interacciones de teclado mejorados en toda la interfaz + + ## Mejoras del assistant y de Analytics + + * Se agregó la visualización de gráfico de barras para las búsquedas del assistant + * Selector de rango de fechas unificado en la página de Analytics del assistant + * Controles de zoom para los gráficos de Analytics del assistant + * Mejor gestión del historial del assistant con atajos de teclado y mejoras en la hoja de chat + + ## Corrección de errores y confiabilidad + + * Se corrigieron problemas de z-index con superposiciones del panel lateral + * Se corrigieron los colores de reserva en modo light y errores de estilo relacionados con temas + * Se corrigió que los expandibles del área de pruebas de la API no funcionaban con enlaces de ancla + * Se mejoró la accesibilidad de enlaces `.md` para ChatGPT y otros agentes LLM + * Se corrigió el manejo de dimensiones de imagen para width y height basados en porcentajes + * Se corrigieron problemas de renderizado de bloques de código con etiquetas de idioma y temas personalizados + * Se corrigió el formato y el estilo de enlaces en Accordion + * Se corrigió el espaciado del pie de página cuando la configuración del assistant está vacía + * Se corrigió el renderizado de icon de tarjeta para imágenes locales del repositorio + * Se corrigió el manejo de archivos de audio en el área de pruebas de la API (se evitó la decodificación UTF-8) + * Se mejoró la gestión del estado de publicación de PR en el editor web + + + + ## Expansión del soporte de idiomas + + * Se agregó compatibilidad con los idiomas rumano y checo en la interfaz de la documentación + * Capacidades de localización mejoradas con cobertura de traducción completa para los nuevos idiomas + * Mejora de la funcionalidad del selector de idioma en todos los temas + + ## Mejoras de la interfaz de usuario y de la experiencia + + * Se corrigieron problemas de visibilidad de pestañas en páginas 404 para evitar resaltar de forma incorrecta la pestaña activa + * Se mejoró el manejo de imágenes con el paso correcto de los atributos width y height para imágenes no optimizadas + * Se mejoró el diseño y la coherencia de estilo de la página 404 ## Mejoras de infraestructura y rendimiento - * Se mejoró el procesamiento de imágenes GIF omitiendo el costoso autoformato de Imgix para reducir el tiempo de procesamiento y el uso de ancho de banda - * Se optimizó el rendimiento de entrega de imágenes con un manejo especial para contenido animado + * Se mejoró el procesamiento de imágenes GIF al omitir el costoso autoformato de Imgix para reducir el tiempo de procesamiento y el uso de ancho de banda + * Se optimizó el rendimiento de entrega de imágenes con manejo especial para contenido animado ## Corrección de errores y confiabilidad * Se corrigió el enrutamiento del correo de contacto en la configuración del dashboard para solicitudes del complemento assistant - * Se mejoraron las actualizaciones del esquema de la base de datos para una mejor gestión de usuarios + * Se mejoraron las actualizaciones del esquema de base de datos para una mejor gestión de usuarios - + ## Mejoras en la integración con GitLab - * Se mejoró la interfaz de conexión con GitLab en la configuración del dashboard para facilitar la gestión del repositorio - * Se agregó soporte de webhooks para actualizaciones automáticas de la documentación en confirmaciones de GitLab + * Interfaz de conexión con GitLab mejorada en la configuración del dashboard para facilitar la gestión del repositorio + * Se agregó compatibilidad con webhooks para actualizaciones automáticas de la documentación en confirmaciones de GitLab - ## Editor web y mejoras de autenticación + ## Mejoras en el editor web y en la autenticación - * Continuó la migración del app router para el editor web, eliminando bloqueos y mejorando el rendimiento - * Se mejoró el manejo de errores de inicio de sesión con mensajes explícitos de validación de correo electrónico - * Se corrigió el manejo de espacios en la validación de direcciones de correo electrónico + * Avances en la migración del app router para el editor web, eliminando bloqueadores y mejorando el rendimiento + * Manejo de errores de inicio de sesión mejorado con mensajes explícitos de validación de correo electrónico + * Se corrigió el manejo de espacios en blanco en la validación de direcciones de correo electrónico ## Corrección de errores y confiabilidad - * Se corrigió la actualización del socket del app router para funciones en tiempo real + * Se corrigió la actualización de sockets del app router para funciones en tiempo real * Se corrigieron problemas de renderizado de rutas SVG en la documentación * Se corrigió la navegación por teclado en la búsqueda y el chat * Se mejoró la confiabilidad del endpoint de estado del historial * Se resolvieron casos límite de middleware y problemas de manejo del evento onClick - - ## Lanzamientos importantes + + ## Lanzamientos principales - * **Mejora importante**: Páginas sugeridas por IA en páginas 404, [cuando alguien entra en un enlace roto → el agente de IA lee la ruta → sugiere páginas semánticamente similares](https://x.com/mintlify/status/1966625627773059495) + * **Mejora importante**: Páginas sugeridas por IA en páginas 404, [cuando alguien llega a un enlace roto → el agente de IA lee la ruta → sugiere páginas semánticamente similares](https://x.com/mintlify/status/1966625627773059495) * **Lanzamiento importante**: la búsqueda web para el assistant ahora puede incluir fuentes externas\ *Nota: Contáctanos para habilitar esta función en tu sitio.* ## Assistant y MCP - * Se corrigió un error por el cual el assistant era limitado por tasa debido a que la ventana de tiempo no se deslizaba correctamente - * Se corrigió un error con la llamada de herramientas del assistant para manejar correctamente bloques `text` vacíos - * Se corrigió un error por el cual los nombres del servidor MCP concatenados con llamadas de herramientas a veces superaban la longitud de 60 caracteres que imponen los clientes MCP - * Se corrigió un error por el cual el menú del assistant tenía una altura varias veces mayor que el viewport y se desplazaba indefinidamente - * Se corrigió un error por el cual los valores de gasto del assistant podían mostrarse con más de dos decimales en el dashboard + * Se corrigió un error donde el assistant era limitado por tasa indebidamente debido a que la ventana de tiempo no se deslizaba correctamente + * Se corrigió un error con las llamadas de herramientas del assistant para manejar correctamente bloques `text` vacíos + * Se corrigió un error donde los nombres del servidor MCP concatenados con llamadas de herramientas a veces excedían la longitud de 60 caracteres que imponen los clientes MCP + * Se corrigió un error donde el menú del assistant tenía una altura varias veces mayor que el viewport y hacía scroll indefinidamente + * Se corrigió un error donde los valores de gasto del assistant podían mostrarse con más de dos decimales en el dashboard ## Editor web e implementaciones - * Se agregó una mejora de seguridad al editor para que solo los usuarios con `write permissions` en el repositorio Git conectado puedan realizar cambios - * Se corrigió un error por el cual las implementaciones de vista previa no funcionaban para branches con `=` en el nombre - * Se corrigió un error por el cual los nombres de branch largos se desbordaban en los modales al crear implementaciones de vista previa - * Mejora de usabilidad: el parámetro de búsqueda de correo electrónico ahora completa previamente el campo en invitaciones de registro - * Se corrigió un error por el cual copiar una página desde el menú contextual no funcionaba en Safari + * Mejora de seguridad en el editor: solo los usuarios con `write permissions` en el repositorio de alojamiento de Git conectado pueden realizar cambios + * Se corrigió un error donde las implementaciones de vista previa no funcionaban para branches con `=` en el nombre + * Se corrigió un error donde los nombres de branch largos desbordaban los modales al crear implementaciones de vista previa + * Mejora de usabilidad: el parámetro de consulta de email rellenará el campo en invitaciones de registro + * Se corrigió un error donde copiar una página desde el menú contextual no funcionaba en Safari ## Área de pruebas de la API y navigation - * Múltiples códigos de respuesta del área de pruebas de la API ahora se muestran en un menú select estilizado y controlado en lugar del select predeterminado del sistema al enfocarse + * Múltiples códigos de respuesta del área de pruebas de la API ahora se muestran en un menú select con estilo controlado en lugar del menú select predeterminado del sistema al enfocarse * Ahora puedes usar el [`expanded` field on navigation groups in your `docs.json` to make them be default open](https://mintlify.com/docs/navigation#default-expanded-state) - ## SEO e interfaz + ## SEO e interfaz de usuario - * Se corrigió un error por el cual los favicons no aparecían en los motores de búsqueda al servirlos desde la misma URL que el propio sitio de documentación para cada sitio correspondiente - * Se corrigió un error por el cual las inserciones de YouTube parpadeaban al cargar - * Se corrigió un error por el cual expandir el menú de comentarios para incluir respuestas escritas causaba un cambio de diseño en la tabla de contenidos - * Se corrigió un error por el cual el texto se filtraba por encima de la barra superior en el tema Maple al descartar la barra de notificación - * Se mejoraron los temas Maple y Willow agregando botones de inicio/cierre de sesión en la barra lateral para facilitar el acceso + * Se corrigió un error donde los favicons no aparecían en los motores de búsqueda, sirviéndolos desde la misma URL que el propio sitio de documentación para cada sitio correspondiente + * Se corrigió un error donde las inserciones de YouTube parpadeaban al cargar + * Se corrigió un error donde expandir el menú de feedback para incluir respuestas escritas causaba un cambio de diseño en la tabla de contenido + * Se corrigió un error donde el texto se desbordaba por encima de la barra superior en el tema Maple al descartar el banner de notificación + * Se mejoraron los temas Maple y Willow añadiendo botones de inicio/cierre de sesión en la barra lateral para un acceso más sencillo ## Analytics y exportaciones - * Se corrigieron problemas de confiabilidad con la vista y las exportaciones de analytics del assistant - * Las exportaciones de analytics del assistant ahora se ejecutan en segundo plano y se envían por correo electrónico para una experiencia más confiable + * Se corrigieron problemas de confiabilidad con la vista de Analytics del assistant y las exportaciones + * Las exportaciones de Analytics del assistant ahora se ejecutan en segundo plano y se envían por correo electrónico para una experiencia más confiable diff --git a/es/customize/themes.mdx b/es/customize/themes.mdx index b05a6501a..d68eddb9e 100644 --- a/es/customize/themes.mdx +++ b/es/customize/themes.mdx @@ -40,13 +40,13 @@ export const ThemeCard = ({ title, value, description, href }) => {
- + - + - + diff --git a/es/editor/content-management.mdx b/es/editor/content-management.mdx deleted file mode 100644 index 192b018ca..000000000 --- a/es/editor/content-management.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: "Administración de contenido" -description: "Crea, edita y organiza tus páginas de documentación" ---- - - - -Usa el explorador de archivos de la barra lateral para explorar tus archivos de documentación. Haz clic en cualquier archivo para abrirlo en el editor. - -Presiona Command + P (Ctrl + P en Windows) para buscar archivos por nombre. - -
- ## Crear páginas nuevas -
- - - - Selecciona el icono **Create a new file** en la barra lateral del explorador de archivos. - - Menú de archivos en el editor web - Menú de archivos en el editor web en modo oscuro - - - Los nombres de archivo deben terminar en `.mdx`. Por ejemplo, `api-reference.mdx` o `getting-started.mdx`. - - - Pulsa Enter para crear el archivo. Se abrirá automáticamente en el editor, listo para añadir contenido. - - - -
- ## Organiza tu navegación -
- -Agrega nuevas páginas a la navegación de tu sitio editando tu `docs.json`. - - - - Busca y abre el archivo `docs.json` en tu directorio raíz usando el explorador de archivos. - - - Encuentra el lugar en el archivo `docs.json` donde quieras agregar tu nueva página. - - - Inserta el nombre de archivo de tu página (sin la extensión `.mdx`) en el arreglo `pages` del grupo correspondiente. - - - -
- ### Ejemplo: Añadir una página de temas -
- -```json title="Adding a themes page to the Profile group" highlight="18" -{ - "navigation": { - "groups": [ - { - "group": "Primeros pasos", - "pages": [ - "index", - "quickstart", - "installation" - ] - }, - { - "group": "Perfil", - "pages": [ - "settings", - "account-types", - "dashboard", - "themes" - ] - } - ] - } -} -``` - - -
- ## Edición de contenido -
- -Realiza cambios en tus páginas usando el modo visual o el Modo Markdown en el editor. - -En el modo visual, presiona / para abrir el menú de componentes. Agrega bloques de contenido, avisos, bloques de código y otros componentes para personalizar tu documentación. - - - El menú de componentes desplegado resaltado en el editor web de Mintlify - El menú de componentes desplegado resaltado en el editor web de Mintlify - - -En el Modo Markdown, puedes editar directamente el `MDX` de tus páginas. Esto puede ser útil cuando necesitas: - -- Definir propiedades específicas de componentes -- Trabajar con componentes anidados complejos -- Copiar y pegar contenido `MDX` de otras fuentes \ No newline at end of file diff --git a/es/editor/getting-started.mdx b/es/editor/getting-started.mdx deleted file mode 100644 index 34cf581f0..000000000 --- a/es/editor/getting-started.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Primeros pasos con el editor web" -sidebarTitle: "Primeros pasos" -description: "Aprende a crear y editar documentación con el editor web" ---- - -Interfaz del editor web de Mintlify en modo claro - -Interfaz del editor web de Mintlify en modo oscuro - -El editor web es una interfaz visual para crear, editar y revisar documentación directamente en tu navegador. - -* **Edición visual**: Realiza cambios en tu documentación con un editor WYSIWYG (what you see is what you get) que muestra cómo se verá tu contenido al publicarse. -* **Sincronización con Git**: Todos los cambios se sincronizan automáticamente con tu repositorio de Git para mantener el control de versiones. -* **Colaboración en equipo**: Varias personas pueden trabajar en la documentación simultáneamente. -* **Integración de componentes**: Agrega avisos, bloques de código y otros componentes con comandos de barra inclinada. -* **Sin configuración**: Comienza a escribir de inmediato desde tu dashboard. - -
- ## Flujo de trabajo del editor web -
- -Así es como normalmente trabajarás en el editor web: - - - - Crea un branch o realiza cambios directamente en tu rama de implementación. Recomendamos crear un branch para que puedas previsualizar tus cambios antes de que se publiquen. - - - - Ve a un archivo existente en la barra lateral o crea uno nuevo usando el explorador de archivos. - - - - Realiza cambios en el editor web. Prueba alternar entre el modo visual y el Modo Markdown usando el interruptor en la esquina superior derecha para ver qué modo prefieres. - - - - El modo visual te muestra cómo se verán tus cambios en tu sitio en producción. Úsalo para verificar que todo se vea correcto. - - - - Si estás trabajando en tu rama de implementación, publica tus cambios directamente desde el editor web. En otros branches, crea una solicitud de extracción para revisión antes de publicar. - - - -
- ## Modos del editor -
- -El editor web tiene dos modos para adaptarse a distintas preferencias y necesidades de edición. Usa el conmutador en la esquina superior derecha de la barra de herramientas del editor para cambiar entre modos de edición. - - - Iconos del conmutador de modo resaltados en el editor web. - - Iconos del conmutador de modo resaltados en el editor web. - - -
- ### Modo visual -
- -El modo visual ofrece una experiencia WYSIWYG (lo que ves es lo que obtienes) en la que los cambios que haces en el editor son los mismos que se publicarán en tu sitio de documentación. Este modo es ideal cuando quieres ver en tiempo real cómo se verán tus cambios. - -Pulsa “/” para abrir el menú de componentes y añadir contenido con estilo, avisos, fragmentos de código u otros componentes. - - - Modo de edición visual en el editor web de Mintlify - - Modo de edición visual en el editor web de Mintlify - - -
- ### Modo Markdown -
- -Markdown mode proporciona acceso directo al código `MDX` subyacente de tu documentación. Este modo es ideal cuando necesitas un control preciso sobre las propiedades de los componentes o cuando prefieres escribir con la sintaxis de Markdown. - - - Markdown mode en el editor web de Mintlify - - Markdown mode en el editor web de Mintlify - - -
- ## Próximos pasos -
- -* Aprende los conceptos fundamentales de [Git](/es/guides/git-concepts). -* Conoce las prácticas recomendadas para colaborar con [branches](/es/guides/branches). -* Explora la [gestión de contenido](/es/editor/content-management) con el editor web. -* Entiende las [opciones de publicación](/es/editor/publishing) para distintos escenarios. \ No newline at end of file diff --git a/es/editor/keyboard-shortcuts.mdx b/es/editor/keyboard-shortcuts.mdx deleted file mode 100644 index 3ce6891a3..000000000 --- a/es/editor/keyboard-shortcuts.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Atajos de teclado" -description: "Atajos para el editor web" ---- - -El editor web admite todos los atajos de teclado habituales, como copiar, pegar, deshacer y seleccionar todo, además de los siguientes atajos: - -| Comando | macOS | Windows | -|:--------|:------|:--------| -| **Buscar archivos** | Cmd + P | Control + P | -| **Añadir enlace al texto seleccionado** | Cmd + K | Control + K | -| **Insertar salto de línea** | Cmd + Enter | Control + Enter | -| **Negrita** | Cmd + B | Control + B | -| **Cursiva** | Cmd + I | Control + I | -| **Subrayado** | Cmd + U | Control + U | -| **Tachado** | Cmd + Shift + S | Control + Shift + S | -| **Código** | Cmd + E | Control + E | -| **Texto normal** | Cmd + Alt + 0 | Control + Alt + 0 | -| **Encabezado 1** | Cmd + Alt + 1 | Control + Alt + 1 | -| **Encabezado 2** | Cmd + Alt + 2 | Control + Alt + 2 | -| **Encabezado 3** | Cmd + Alt + 3 | Control + Alt + 3 | -| **Encabezado 4** | Cmd + Alt + 4 | Control + Alt + 4 | -| **Lista numerada** | Cmd + Shift + 7 | Control + Shift + 7 | -| **Lista con viñetas** | Cmd + Shift + 8 | Control + Shift + 8 | -| **Cita en bloque** | Cmd + Shift + B | Control + Shift + B | -| **Subíndice** | Cmd + , | Control + , | -| **Superíndice** | Cmd + . | Control + . | \ No newline at end of file diff --git a/es/editor/publishing.mdx b/es/editor/publishing.mdx deleted file mode 100644 index 752e875c1..000000000 --- a/es/editor/publishing.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "Publicación de tus cambios" -description: "Implementa las actualizaciones de tu documentación directamente en producción o mediante solicitudes de extracción" ---- - -La forma en que se publican tus cambios depende de en qué branch estés trabajando: - -* **Rama de implementación**: Publicar actualiza tu sitio en producción de inmediato. -* **Otras ramas**: Publicar crea una solicitud de extracción para que puedas revisar los cambios antes de que se implementen en producción. - - - El botón Publicar resaltado en el editor web de Mintlify - El botón Publicar resaltado en el editor web de Mintlify - - -
- ## Solicitudes de extracción y revisión de cambios -
- -Las solicitudes de extracción te permiten proponer cambios desde tu branch para que otras personas los revisen antes de integrarlos en tu documentación en producción. Esto ayuda a asegurar que tus cambios sean correctos y le da a tu equipo la oportunidad de colaborar en el contenido. - - - Incluso si trabajas en solitario, las solicitudes de extracción son útiles para previsualizar cambios y mantener un historial claro de actualizaciones. - - -
- ### Crear una solicitud de extracción -
- - - - Asegúrate de que todos tus cambios se hayan guardado en tu branch usando **Guardar cambios**. - - - Selecciona **Publish Pull Request** en la esquina superior derecha del editor. - - - Escribe un título y una descripción claros que expliquen: - - Qué cambios realizaste - - Por qué los hiciste - - Cualquier área específica que necesite revisión - - - Selecciona **Publish Pull Request**. El editor proporcionará un enlace para ver tu solicitud de extracción. - - - Botón Publish Pull Request resaltado en el editor web de Mintlify - Botón Publish Pull Request resaltado en el editor web de Mintlify - - - - -
- ## Revisar solicitudes de extracción -
- -Una vez que se crea tu solicitud de extracción: - -1. **Revisar cambios**: Tú y los miembros de tu equipo pueden revisar tu solicitud de extracción en tu proveedor de Git, como GitHub o GitLab. -2. **Dejar comentarios**: Agrega comentarios o solicita cambios. -3. **Hacer cambios adicionales**: Realiza cambios adicionales en el editor web. Cuando guardas cambios, el editor los envía a tu solicitud de extracción. -4. **Aprobar**: Aprueba la solicitud de extracción cuando estés conforme con los cambios. -5. **Fusionar**: Fusiona la solicitud de extracción cuando estés listo para implementar tus cambios en producción. \ No newline at end of file diff --git a/es/editor/troubleshooting.mdx b/es/editor/troubleshooting.mdx deleted file mode 100644 index 3f97a02d8..000000000 --- a/es/editor/troubleshooting.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "Solución de problemas del editor web" -sidebarTitle: "Solución de problemas" -description: "Soluciones a problemas comunes" ---- - -Encuentra soluciones a problemas comunes que podrías encontrar al usar el editor web. - - - - **Posibles causas:** - - * La implementación aún está en curso - * Problemas de caché del navegador - * Errores de compilación o de implementación - - **Soluciones:** - - 1. Revisa el estado de la implementación en tu dashboard. - 2. Realiza una recarga forzada del navegador (Ctrl + F5 o Cmd + Shift + R) - 3. Borra la caché del navegador. - - - - **Posibles causas:** - - * Permisos insuficientes en el repositorio de Git - * Problemas de autenticación con tu proveedor de Git - - **Soluciones:** - - 1. Verifica que tengas el acceso correcto al repositorio. - 2. Comprueba si tu integración de Git está configurada correctamente. - 3. Revisa la documentación de [Permisos del editor](/es/dashboard/permissions). - - - - **Posibles causas:** - - * Problemas de conectividad de red - * Repositorios de documentación muy grandes - - **Soluciones:** - - 1. Verifica tu conexión a Internet. - 2. Actualiza la página. - 3. Contacta al soporte si el problema persiste. - - - - **Posibles causas:** - - * Sintaxis MDX inválida en los archivos - * Archivos faltantes o dañados - * Archivos muy grandes que provocan tiempos de espera - - **Soluciones:** - - 1. Revisa la sintaxis del archivo para detectar errores de formato en MDX. - 2. Verifica que el archivo exista en tu repositorio. - - \ No newline at end of file diff --git a/es/index.mdx b/es/index.mdx index 586998df0..db5836944 100644 --- a/es/index.mdx +++ b/es/index.mdx @@ -1,6 +1,6 @@ --- title: "Introducción" -description: "Descubre la próxima generación de documentación. Nativa de IA, atractiva desde el primer momento y creada para desarrolladores." +description: "Conoce la próxima generación de documentación: nativa de IA, atractiva desde el primer momento y creada para desarrolladores." mode: "frame" --- @@ -24,7 +24,7 @@ export const HeroCard = ({ filename, title, description, href }) => { };
-
+
Imagen de fondo decorativa. Imagen de fondo decorativa. @@ -36,17 +36,17 @@ export const HeroCard = ({ filename, title, description, href }) => {
- Descubre la próxima generación de documentación: nativa de IA, atractiva desde el primer momento y creada para desarrolladores. + Descubre la próxima generación de documentación. Nativa de IA, atractiva desde el primer momento y creada para desarrolladores.
- + - + - +
diff --git a/es/organize/pages.mdx b/es/organize/pages.mdx index 615b93e87..b5053aabf 100644 --- a/es/organize/pages.mdx +++ b/es/organize/pages.mdx @@ -95,7 +95,7 @@ mode: "wide" ### Personalizado
-El modo personalizado ofrece un diseño minimalista que elimina todos los elementos excepto la barra superior. Es un lienzo en blanco para crear páginas de destino u otros diseños únicos en los que quieras mantener la navigation al mínimo. El modo personalizado está disponible para todos los temas. +El modo Personalizado ofrece un diseño minimalista que elimina todos los elementos excepto la barra de navegación superior. Es un lienzo en blanco para crear páginas de destino u otros diseños únicos en los que quieras que los elementos de navegación sean mínimos. El modo Personalizado está disponible para todos los temas. ```yaml --- diff --git a/fr/api/agent/create-agent-job.mdx b/fr/api/agent/create-agent-job.mdx index f51512b01..0a4dd357f 100644 --- a/fr/api/agent/create-agent-job.mdx +++ b/fr/api/agent/create-agent-job.mdx @@ -2,7 +2,7 @@ openapi: POST /agent/{projectId}/job --- -Cet endpoint crée une tâche d’agent à partir des messages fournis et des informations de branche. La tâche s’exécute de manière asynchrone et renvoie une réponse en streaming avec les détails d’exécution et les résultats. +Ce point de terminaison crée une tâche d’agent à partir des messages fournis et des informations de branche. La tâche s’exécute de manière asynchrone et renvoie une réponse en streaming contenant les détails d’exécution et les résultats. Si la branche n’existe pas, l’agent en crée une. Si des fichiers sont modifiés avec succès, une pull request (demande de fusion) en brouillon est automatiquement créée à la fin de la tâche. @@ -10,7 +10,7 @@ Si la branche n’existe pas, l’agent en crée une. Si des fichiers sont modif ## Limites de débit
-L’API de l’agent présente les limites suivantes : +L’API de l’agent est soumise aux limites suivantes : - 100 utilisations par projet Mintlify et par heure @@ -18,4 +18,4 @@ L’API de l’agent présente les limites suivantes : ## Utilisation recommandée -Pour de meilleurs résultats, utilisez le [hook useChat d’ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) pour envoyer des requêtes et traiter les réponses. \ No newline at end of file +Pour de meilleurs résultats, utilisez le [hook useChat d’ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) pour envoyer des requêtes et gérer les réponses. \ No newline at end of file diff --git a/fr/api/agent/get-agent-job.mdx b/fr/api/agent/get-agent-job.mdx index 7db138875..bb154d8d9 100644 --- a/fr/api/agent/get-agent-job.mdx +++ b/fr/api/agent/get-agent-job.mdx @@ -6,14 +6,14 @@ openapi: GET /agent/{projectId}/job/{id} ## Utilisation -Cet endpoint renvoie les détails et l’état d’un travail d’agent spécifique à partir de son identifiant unique. Utilisez-le pour vérifier la progression, l’état et les résultats d’un travail d’agent précédemment créé. +Ce point de terminaison récupère les détails et l’état d’une tâche d’agent spécifique à partir de son identifiant unique. Utilisez-le pour vérifier la progression, l’état et les résultats d’une tâche d’agent créée précédemment.
## Détails du job
-La réponse inclut des informations telles que : +La réponse inclut des informations telles que : - Statut d’exécution du job et état d’achèvement -- Informations de branche et détails du pull request (demande de fusion) +- Informations sur la branche et détails du pull request (demande de fusion) - metadata de session et horodatages \ No newline at end of file diff --git a/fr/api/agent/get-all-jobs.mdx b/fr/api/agent/get-all-jobs.mdx index 0275e8288..ce4876c67 100644 --- a/fr/api/agent/get-all-jobs.mdx +++ b/fr/api/agent/get-all-jobs.mdx @@ -12,4 +12,4 @@ Cet endpoint récupère tous les jobs d’agent pour le domain spécifié, offra ## Réponse -Utilisez cet endpoint pour obtenir une vue d’ensemble de toutes les sessions d’agent précédentes. \ No newline at end of file +Utilisez ce point de terminaison pour obtenir une vue d’ensemble de toutes les sessions d’agent précédentes. \ No newline at end of file diff --git a/fr/api/assistant/create-assistant-message.mdx b/fr/api/assistant/create-assistant-message.mdx index 10906d226..12fecbc92 100644 --- a/fr/api/assistant/create-assistant-message.mdx +++ b/fr/api/assistant/create-assistant-message.mdx @@ -2,24 +2,20 @@ openapi: POST /assistant/{domain}/message --- - -
## Limites de débit
-L’API de l’Assistant comporte les limites suivantes : +L’API de l’Assistant applique les limites suivantes : - 10 000 utilisations par key et par mois - 10 000 requêtes par organisation Mintlify et par heure - 10 000 requêtes par adresse IP et par jour - -
## Utilisation recommandée
Pour de meilleurs résultats, utilisez le [hook useChat d’ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) pour envoyer des requêtes et gérer les réponses. -Vous pouvez définir `fp`, `threadId` et `filter` dans le champ `body` du paramètre options passé au hook. \ No newline at end of file +Vous pouvez définir `fp`, `threadId` et `filter` dans le champ `body` du paramètre options transmis au hook. \ No newline at end of file diff --git a/fr/api/assistant/create-topic.mdx b/fr/api/assistant/create-topic.mdx index dc00663e3..30ad8b74f 100644 --- a/fr/api/assistant/create-topic.mdx +++ b/fr/api/assistant/create-topic.mdx @@ -1,3 +1,3 @@ --- openapi: POST /chat/topic ---- +--- \ No newline at end of file diff --git a/fr/api/assistant/generate-message.mdx b/fr/api/assistant/generate-message.mdx index b1cdbbb37..30a74c542 100644 --- a/fr/api/assistant/generate-message.mdx +++ b/fr/api/assistant/generate-message.mdx @@ -1,3 +1,3 @@ --- openapi: POST /chat/message ---- +--- \ No newline at end of file diff --git a/fr/api/assistant/search.mdx b/fr/api/assistant/search.mdx index aad5f0e85..d0c97a8da 100644 --- a/fr/api/assistant/search.mdx +++ b/fr/api/assistant/search.mdx @@ -1,3 +1,3 @@ --- openapi: "POST /search/{domain}" ---- +--- \ No newline at end of file diff --git a/fr/api/introduction.mdx b/fr/api/introduction.mdx index b89c5944c..dfe68479a 100644 --- a/fr/api/introduction.mdx +++ b/fr/api/introduction.mdx @@ -3,46 +3,46 @@ title: "Introduction" description: "Déclenchez des mises à jour, intégrez l’Assistant IA et plus encore" --- -L’API REST de Mintlify vous permet d’interagir de manière programmatique avec votre documentation, de déclencher des mises à jour et d’intégrer des expériences de chat propulsées par l’IA. +L’API REST de Mintlify vous permet d’interagir par programmation avec votre documentation, de déclencher des mises à jour et d’intégrer des expériences de chat alimentées par l’IA.
- ## Endpoints + ## Points de terminaison
-* [Déclencher une mise à jour](/fr/api-reference/update/trigger): Déclenchez une mise à jour de votre site quand vous le souhaitez. -* [Obtenir l’état de la mise à jour](/fr/api-reference/update/status): Obtenez l’état d’une mise à jour et d’autres détails sur votre documentation. -* [Créer une tâche d’agent](/fr/api-reference/agent/create-agent-job): Créez une tâche d’agent pour modifier automatiquement votre documentation. -* [Obtenir une tâche d’agent](/fr/api-reference/agent/get-agent-job): Récupérez les détails et l’état d’une tâche d’agent spécifique. -* [Obtenir toutes les tâches d’agent](/fr/api-reference/agent/get-all-jobs): Récupérez toutes les tâches d’agent pour un domain. -* [Générer un message Assistant](/fr/api-reference/assistant/create-assistant-message): Intégrez l’Assistant, entraîné sur votre documentation, dans n’importe quelle application de votre choix. -* [Rechercher dans la documentation](/fr/api-reference/assistant/search): Recherchez dans votre documentation. +* [Déclencher une mise à jour](/fr/api-reference/update/trigger) : Déclenchez une mise à jour de votre site lorsque vous le souhaitez. +* [Obtenir l’état de la mise à jour](/fr/api-reference/update/status) : Obtenez l’état d’une mise à jour et d’autres détails sur votre documentation. +* [Créer une tâche d’agent](/fr/api-reference/agent/create-agent-job) : Créez une tâche d’agent pour modifier automatiquement votre documentation. +* [Obtenir une tâche d’agent](/fr/api-reference/agent/get-agent-job) : Récupérez les détails et l’état d’une tâche d’agent spécifique. +* [Obtenir toutes les tâches d’agent](/fr/api-reference/agent/get-all-jobs) : Récupérez toutes les tâches d’agent pour un domain. +* [Générer un message de l’Assistant](/fr/api-reference/assistant/create-assistant-message) : Intégrez l’Assistant, entraîné sur votre documentation, dans n’importe quelle application de votre choix. +* [Rechercher dans la documentation](/fr/api-reference/assistant/search) : Recherchez dans votre documentation.
## Authentification
-Vous pouvez générer une clé d’API via [le Dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). Les clés d’API sont associées à l’ensemble d’une organisation et peuvent être utilisées sur plusieurs déploiements. +Vous pouvez générer une clé d’API depuis [le Dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). Les clés d’API sont associées à toute l’organisation et peuvent être utilisées sur plusieurs déploiements.
### Clé d’API administrateur
-La clé d’API administrateur est utilisée pour [déclencher une mise à jour](/fr/api-reference/update/trigger), [obtenir l’état de mise à jour](/fr/api-reference/update/status) ainsi que pour tous les endpoints d’agent. +La clé d’API administrateur est utilisée pour [déclencher une mise à jour](/fr/api-reference/update/trigger), [obtenir l’état de la mise à jour](/fr/api-reference/update/status) et pour tous les points de terminaison de l’agent. -Les clés d’API administrateur commencent par le préfixe `mint_`. Gardez vos clés d’API administrateur secrètes. +Les clés d’API administrateur commencent par le préfixe `mint_`. Gardez vos clés d’API administrateur confidentielles.
### Clé d’API de l’Assistant
-La clé d’API de l’Assistant est utilisée pour les endpoints [Generate assistant message](/fr/api-reference/assistant/create-assistant-message) et [Search documentation](/fr/api-reference/assistant/search). +La clé d’API de l’Assistant est utilisée pour les points de terminaison [Générer un message de l’assistant](/fr/api-reference/assistant/create-assistant-message) et [Rechercher dans la documentation](/fr/api-reference/assistant/search). Les clés d’API de l’Assistant commencent par le préfixe `mint_dsc_`. -La **key** d’API de l’Assistant est un jeton côté serveur qui doit rester secret. +La **key** de l’API de l’Assistant est un jeton côté serveur qui doit rester secret. -Le **token** d’API de l’Assistant est un jeton public qui peut être référencé dans votre code frontend. +Le **token** de l’API de l’Assistant est un jeton public qui peut être référencé dans votre code front-end. - Les appels utilisant le token d’API de l’Assistant peuvent entraîner des coûts : soit en utilisant vos crédits d’Assistant IA, soit en générant des dépassements. + Les appels utilisant le token de l’API de l’Assistant peuvent entraîner des coûts : soit en utilisant vos crédits d’Assistant IA, soit en engendrant des dépassements. \ No newline at end of file diff --git a/fr/api/update/status.mdx b/fr/api/update/status.mdx index 9e2e93b66..1ea0b419a 100644 --- a/fr/api/update/status.mdx +++ b/fr/api/update/status.mdx @@ -1,3 +1,3 @@ --- openapi: "GET /project/update-status/{statusId}" ---- +--- \ No newline at end of file diff --git a/fr/api/update/trigger.mdx b/fr/api/update/trigger.mdx index 26b0968f3..e4d85f180 100644 --- a/fr/api/update/trigger.mdx +++ b/fr/api/update/trigger.mdx @@ -1,3 +1,3 @@ --- openapi: "POST /project/update/{projectId}" ---- +--- \ No newline at end of file diff --git a/fr/changelog.mdx b/fr/changelog.mdx index 6b796d1d3..ff012f330 100644 --- a/fr/changelog.mdx +++ b/fr/changelog.mdx @@ -1,95 +1,136 @@ --- -title: "Mises à jour du produit" +title: "Mises à jour produit" description: "Nouvelles versions et améliorations" rss: true noindex: true --- - + + ## Nouvelles fonctionnalités + + * **Navigation des produits**: Organisez la documentation de plusieurs produits avec le sélecteur de produit dans la navigation + * **Commande d’interface en ligne de commande (CLI) pour l’accessibilité**: Exécutez `mint a11y` pour tester l’accessibilité de votre documentation + * **Réponses vidéo dans le bac à sable d’API**: Le bac à sable d’API prend désormais en charge l’affichage des réponses vidéo + * **Préremplissage du bac à sable d’API**: Nouvelle option pour préremplir les exemples du bac à sable d’API et accélérer les tests + * **Commentaires non authentifiés**: Pour les sites avec authentification partielle, les utilisateurs peuvent désormais envoyer des commentaires sans être authentifiés + * **Prise en charge des thèmes Shiki**: Les thèmes Shiki sont désormais pris en charge pour le style des code blocks + * **Twoslash pour les code blocks**: Les code blocks TypeScript et JavaScript prennent désormais en charge Twoslash pour l’inférence de types en ligne + + ## Améliorations d’accessibilité + + * Ajout d’attributs ARIA complets sur les composants pour un meilleur support des lecteurs d’écran + * Nouveau bouton « passer au contenu principal » pour la navigation au clavier + * Prise en charge des flèches de direction dans les composants d’onglets + * Infobulles, listes imbriquées et accessibilité des groupes de code améliorées + * États de focus et interactions clavier améliorés dans toute l’interface + + ## Améliorations de l’Assistant et des Analytics + + * Ajout d’un histogramme pour l’analyse des requêtes de l’Assistant + * Sélecteur de plage de dates unifié sur la page Analytics de l’Assistant + * Contrôles de zoom pour les graphiques Analytics de l’Assistant + * Meilleure gestion de l’historique de l’Assistant avec raccourcis clavier et améliorations du panneau de chat + + ## Corrections de bugs et fiabilité + + * Correction des problèmes de z-index avec les superpositions du panneau latéral + * Correction des couleurs de repli en mode clair et des bugs de style liés aux thèmes + * Correction des éléments extensibles du bac à sable d’API qui ne fonctionnaient pas avec les liens d’ancrage + * Correction de l’accessibilité des liens `.md` pour ChatGPT et autres agents LLM + * Correction de la gestion des dimensions d’image pour les largeurs et hauteurs en pourcentage + * Correction des problèmes de rendu des code blocks avec les balises de langage et les thèmes personnalisés + * Correction du formatage et du style des liens dans les accordéons + * Correction des espacements du pied de page lorsque la configuration de l’Assistant est vide + * Correction du rendu des icônes de carte pour les images du référentiel local + * Correction de la gestion des fichiers audio dans le bac à sable d’API (empêche le décodage UTF-8) + * Amélioration de la gestion de l’état de publication des PR dans l’éditeur web + + + ## Extension de la prise en charge des langues * Ajout de la prise en charge du roumain et du tchèque dans l’interface de documentation - * Capacités de localisation étendues avec une couverture de traduction complète pour les nouvelles langues + * Capacités de localisation améliorées avec une couverture de traduction complète pour les nouvelles langues * Amélioration du sélecteur de langue sur tous les thèmes ## Améliorations de l’UI et de l’expérience utilisateur - * Correction des problèmes de visibilité des onglets sur les pages 404 pour éviter une mise en évidence incorrecte de l’onglet actif + * Correction de la visibilité des onglets sur les pages 404 pour éviter une mise en évidence incorrecte de l’onglet actif * Amélioration de la gestion des images avec passage correct des attributs width et height pour les images non optimisées - * Mise en page et cohérence du style de la page 404 améliorées + * Amélioration de la mise en page et de la cohérence du style de la page 404 ## Améliorations de l’infrastructure et des performances - * Amélioration du traitement des images GIF en évitant le formatage automatique Imgix coûteux afin de réduire le temps de traitement et l’utilisation de la bande passante - * Optimisation de la diffusion des images avec une gestion spécifique du contenu animé + * Amélioration du traitement des GIF en évitant le formatage automatique coûteux d’Imgix afin de réduire le temps de traitement et l’utilisation de la bande passante + * Optimisation des performances de diffusion d’images avec un traitement spécifique pour le contenu animé ## Corrections de bugs et fiabilité - * Correction du routage des e‑mails de contact dans les paramètres du Dashboard pour les demandes d’add-on Assistant + * Correction du routage des e-mails de contact dans les paramètres du Dashboard pour les demandes d’add-on Assistant * Amélioration des mises à jour du schéma de base de données pour une meilleure gestion des utilisateurs - + ## Améliorations de l’intégration GitLab - * Amélioration de l’UI de connexion à GitLab dans les paramètres du Dashboard pour faciliter la gestion des référentiels - * Ajout de la prise en charge des webhooks pour les mises à jour automatiques de la documentation lors des commits GitLab + * Amélioration de l’interface de connexion à GitLab dans les paramètres du Dashboard pour une gestion plus simple des référentiels + * Ajout de la prise en charge des webhooks pour des mises à jour automatiques de la documentation lors des commits GitLab - ## Éditeur web et améliorations de l’authentification + ## Améliorations de l’éditeur web et de l’authentification * Poursuite de la migration de l’app router pour l’éditeur web, suppression des blocages et amélioration des performances - * Amélioration de la gestion des erreurs de connexion avec des messages explicites de validation d’e‑mail + * Amélioration de la gestion des erreurs de connexion avec des messages explicites de validation d’e-mail * Correction de la gestion des espaces dans la validation des adresses e‑mail ## Corrections de bugs et fiabilité - * Correction de la mise à jour du socket de l’app router pour les fonctionnalités en temps réel - * Correction des problèmes de rendu des tracés SVG dans la documentation + * Correction de la mise à jour des sockets de l’app router pour les fonctionnalités en temps réel + * Correction des problèmes de rendu des chemins SVG dans la documentation * Correction de la navigation au clavier dans la recherche et le chat - * Amélioration de la fiabilité de l’endpoint d’état de l’historique - * Résolution de cas limites de middleware et de problèmes de gestion de l’événement onClick + * Amélioration de la fiabilité de l’endpoint de statut d’historique + * Résolution de cas limites du middleware et des problèmes de gestion des événements onClick - + ## Versions majeures - * Amélioration majeure : pages suggérées par l’IA sur les pages 404, [quand quelqu’un arrive sur un lien mort → l’agent IA lit le chemin → suggère des pages sémantiquement similaires](https://x.com/mintlify/status/1966625627773059495) - * Version majeure : la recherche web pour l’Assistant peut désormais inclure des sources externes\ - Remarque : Contactez-nous pour activer cette fonctionnalité pour votre site. + * **Amélioration majeure** : pages suggérées par l’IA sur les pages 404, [quand quelqu’un arrive sur un lien mort → l’agent IA lit le chemin → propose des pages sémantiquement similaires](https://x.com/mintlify/status/1966625627773059495) + * **Version majeure** : la recherche web de l’Assistant peut désormais inclure des sources externes\ + *Remarque : contactez-nous pour activer cette fonctionnalité pour votre site.* ## Assistant et MCP - * Correction d’un bug où l’Assistant était limité à tort par le taux de requêtes car la fenêtre temporelle ne défilait pas correctement + * Correction d’un bug où l’Assistant était limité en débit de manière incorrecte à cause d’une fenêtre glissante qui ne se décalait pas correctement * Correction d’un bug dans l’appel d’outils de l’Assistant pour gérer correctement les blocs `text` vides - * Correction d’un bug où les noms de serveur MCP concaténés avec les appels d’outils dépassaient parfois la limite de 60 caractères imposée par les clients MCP - * Correction d’un bug où le menu de l’Assistant avait une height plusieurs fois supérieure à la zone d’affichage et défilait indéfiniment - * Correction d’un bug où les valeurs de dépenses de l’Assistant pouvaient s’afficher avec plus de deux décimales dans le Dashboard + * Correction d’un bug où le nom du serveur MCP, concaténé avec les appels d’outils, dépassait parfois la limite de 60 caractères imposée par les clients MCP + * Correction d’un bug où le menu de l’Assistant avait une height plusieurs fois supérieure à la fenêtre d’affichage et défilait indéfiniment + * Correction d’un bug où les montants de consommation de l’Assistant pouvaient s’afficher avec plus de deux décimales dans le Dashboard ## Éditeur web et déploiements - * Renforcement de la sécurité de l’éditeur afin que seuls les utilisateurs disposant des `write permissions` sur le référentiel Git connecté puissent apporter des modifications - * Correction d’un bug où les aperçus de déploiement ne fonctionnaient pas pour les branches dont le nom contient `=` - * Correction d’un bug où les noms de branche longs débordaient des modales lors de la création d’aperçus de déploiement - * Amélioration de confort : le paramètre de requête e‑mail préremplit désormais le champ dans les invitations d’inscription + * Renforcement de la sécurité de l’éditeur : seuls les utilisateurs disposant des `write permissions` pour le référentiel Git connecté peuvent effectuer des modifications + * Correction d’un bug où les déploiements de prévisualisation ne fonctionnaient pas pour les branches contenant un `=` dans le nom + * Correction d’un bug où les noms de branche longs débordaient des modales lors de la création d’un déploiement de prévisualisation + * Amélioration de l’ergonomie : le paramètre de requête email préremplit désormais le champ dans les invitations d’inscription * Correction d’un bug où la copie d’une page depuis le menu contextuel ne fonctionnait pas sur Safari ## Bac à sable d’API et navigation - * Plusieurs codes de réponse du bac à sable d’API s’affichent désormais dans un menu select stylisé contrôlé au lieu du menu select système lorsqu’il est focalisé - * Vous pouvez maintenant utiliser le champ [`expanded` sur les groupes de navigation dans votre `docs.json` pour qu’ils soient ouverts par défaut](https://mintlify.com/docs/navigation#default-expanded-state) + * Plusieurs codes de réponse du bac à sable d’API s’affichent désormais dans un menu select stylisé contrôlé au lieu du select par défaut du système lorsqu’il est en focus + * Vous pouvez désormais utiliser le [champ `expanded` sur les groups de la navigation dans votre `docs.json` pour les ouvrir par défaut](https://mintlify.com/docs/navigation#default-expanded-state) - ## SEO et UI + ## SEO et interface - * Correction d’un bug où les favicons n’apparaissaient pas dans les moteurs de recherche en les servant depuis la même URL que le site de documentation pour chaque site concerné + * Correction d’un bug où les favicons n’apparaissaient pas dans les moteurs de recherche, en les servant depuis la même URL que le site de documentation lui-même pour chaque site concerné * Correction d’un bug où les intégrations YouTube clignotaient au chargement - * Correction d’un bug où l’extension du menu de feedback pour inclure des réponses écrites provoquait un décalage de mise en page avec la table des matières - * Correction d’un bug où le texte dépassait au‑dessus de la barre supérieure sur le thème Maple après rejet de la bannière de notification - * Amélioration des thèmes Maple et Willow avec l’ajout de boutons de connexion/déconnexion dans la barre latérale pour un accès plus facile + * Correction d’un bug où l’extension du menu de retour d’expérience pour inclure des réponses écrites provoquait un décalage de mise en page avec la table des matières + * Correction d’un bug où le texte dépassait au-dessus de la barre supérieure sur le thème Maple lorsqu’on fermait la bannière de notification + * Amélioration des thèmes Maple et Willow avec l’ajout de boutons Connexion/Déconnexion dans la barre latérale pour un accès plus facile ## Analytics et exports - * Correction des problèmes de fiabilité de la vue Analytics de l’Assistant et des exports - * Les exports Analytics de l’Assistant sont désormais exécutés en arrière‑plan et envoyés par e‑mail pour une expérience plus fiable + * Correction de problèmes de fiabilité avec la vue Analytics de l’Assistant et les exports + * Les exports Analytics de l’Assistant sont désormais exécutés en arrière-plan et envoyés par email pour une expérience plus fiable diff --git a/fr/customize/themes.mdx b/fr/customize/themes.mdx index 41b287b5d..30e417d50 100644 --- a/fr/customize/themes.mdx +++ b/fr/customize/themes.mdx @@ -1,6 +1,6 @@ --- title: "Thèmes" -description: "Personnaliser l’apparence de votre documentation" +description: "Personnalisez l’apparence de votre documentation" mode: "frame" --- @@ -19,7 +19,7 @@ export const ThemeCard = ({ title, value, description, href }) => {
{description}
- Afficher l’aperçu + Voir l’aperçu @@ -40,15 +40,15 @@ export const ThemeCard = ({ title, value, description, href }) => {
- + - + - + - +
diff --git a/fr/editor/content-management.mdx b/fr/editor/content-management.mdx deleted file mode 100644 index 2d974d152..000000000 --- a/fr/editor/content-management.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: "Gestion du contenu" -description: "Créez, modifiez et organisez vos pages de documentation" ---- - - - -Utilisez l’explorateur de fichiers dans la barre latérale pour parcourir vos fichiers de documentation. Cliquez sur un fichier pour l’ouvrir dans l’éditeur. - -Appuyez sur Command + P (Ctrl + P sous Windows) pour rechercher des fichiers par nom. - -
- ## Créer de nouvelles pages -
- - - - Sélectionnez l’icône **Créer un nouveau fichier** dans la barre latérale de l’explorateur de fichiers. - - Menu Fichiers dans l’éditeur web - Menu Fichiers dans l’éditeur web en mode sombre - - - Les noms de fichiers doivent se terminer par `.mdx`. Par exemple : `api-reference.mdx` ou `getting-started.mdx`. - - - Appuyez sur Entrée pour créer le fichier. Il s’ouvre automatiquement dans l’éditeur, prêt à recevoir du contenu. - - - -
- ## Organiser votre navigation -
- -Ajoutez de nouvelles pages à la navigation de votre site en modifiant le fichier `docs.json`. - - - - Recherchez et ouvrez le fichier `docs.json` à la racine de votre projet via l’explorateur de fichiers. - - - Repérez l’endroit dans le fichier `docs.json` où vous souhaitez ajouter votre nouvelle page. - - - Insérez le nom de fichier de votre page (sans l’extension `.mdx`) dans le tableau `pages` du groupe approprié. - - - -
- ### Exemple : ajouter une page de thèmes -
- -```json title="Adding a themes page to the Profile group" highlight="18" -{ - "navigation": { - "groups": [ - { - "group": "Prise en main", - "pages": [ - "index", - "quickstart", - "installation" - ] - }, - { - "group": "Profil", - "pages": [ - "settings", - "account-types", - "dashboard", - "themes" - ] - } - ] - } -} -``` - - -
- ## Modification du contenu -
- -Apportez des modifications à vos pages en utilisant le mode visuel ou le Mode Markdown dans l’éditeur. - -En mode visuel, appuyez sur / pour ouvrir le menu des composants. Ajoutez des blocs de contenu, des encadrés, des blocs de code et d’autres composants pour personnaliser votre documentation. - - - Le menu des composants déployé, mis en évidence dans l’éditeur web Mintlify - Le menu des composants déployé, mis en évidence dans l’éditeur web Mintlify - - -En Mode Markdown, vous pouvez modifier directement le `MDX` de vos pages. Cela peut être utile lorsque vous devez : - -- Définir des propriétés spécifiques de composants -- Travailler avec des composants imbriqués complexes -- Copier et coller du contenu `MDX` depuis d’autres sources \ No newline at end of file diff --git a/fr/editor/getting-started.mdx b/fr/editor/getting-started.mdx deleted file mode 100644 index 6839201dc..000000000 --- a/fr/editor/getting-started.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Bien démarrer avec l’éditeur web" -sidebarTitle: "Bien démarrer" -description: "Apprenez à créer et à modifier de la documentation avec l’éditeur web" ---- - -Interface de l’éditeur web Mintlify en mode clair - -Interface de l’éditeur web Mintlify en mode sombre - -L’éditeur web est une interface visuelle pour créer, modifier et relire de la documentation directement dans votre navigateur. - -* **Édition visuelle** : Modifiez votre documentation avec un éditeur WYSIWYG (What You See Is What You Get) qui montre le rendu final de votre contenu. -* **Synchronisation Git** : Toutes les modifications sont automatiquement synchronisées avec votre référentiel Git pour maintenir le contrôle de version. -* **Collaboration en équipe** : Plusieurs personnes peuvent travailler simultanément sur la documentation. -* **Intégration de composants** : Ajoutez des encarts, des blocs de code et d’autres composants à l’aide de commandes slash. -* **Aucune configuration requise** : Commencez à écrire immédiatement depuis votre Dashboard. - -
- ## Flux de travail de l’éditeur web -
- -Voici comment vous travaillerez généralement dans l’éditeur web : - - - - Créez une branche ou apportez des modifications directement à votre branche de déploiement. Nous recommandons de créer une branche afin de pouvoir prévisualiser vos modifications avant leur mise en ligne. - - - - Accédez à un fichier existant dans la barre latérale ou créez-en un nouveau à l’aide de l’explorateur de fichiers. - - - - Apportez des modifications dans l’éditeur web. Essayez d’alterner entre le mode visuel et le Mode Markdown à l’aide du basculeur situé dans le coin supérieur droit pour voir quel mode vous préférez. - - - - Le mode visuel vous montre comment vos modifications apparaîtront sur votre site en production. Utilisez-le pour vérifier que tout est correct. - - - - Si vous travaillez sur votre branche de déploiement, publiez vos modifications directement depuis l’éditeur web. Sur les autres branches, créez une pull request (demande de fusion) pour relecture avant la publication. - - - -
- ## Modes de l’éditeur -
- -L’éditeur web propose deux modes pour s’adapter à différentes préférences et besoins d’édition. Utilisez le commutateur dans l’angle supérieur droit de la barre d’outils de l’éditeur pour passer d’un mode à l’autre. - - - Icônes de commutation de mode mises en évidence dans l’éditeur web. - - Icônes de commutation de mode mises en évidence dans l’éditeur web. - - -
- ### Mode visuel -
- -Le mode visuel offre une expérience WYSIWYG (What You See Is What You Get) où les modifications que vous effectuez dans l’éditeur sont exactement celles qui seront publiées sur votre site de documentation. Ce mode est idéal pour prévisualiser en temps réel l’apparence de vos modifications. - -Appuyez sur « / » pour ouvrir le menu des composants et ajouter du contenu mis en forme, des encadrés, des extraits de code ou d’autres composants. - - - Mode d’édition visuel dans l’éditeur web Mintlify - - Mode d’édition visuel dans l’éditeur web Mintlify - - -
- ### Mode Markdown -
- -Le mode Markdown donne un accès direct au code `MDX` sous-jacent de votre documentation. Ce mode est idéal lorsque vous avez besoin d’un contrôle précis des propriétés des composants ou lorsque vous préférez écrire en syntaxe Markdown. - - - Mode Markdown dans l’éditeur web Mintlify - - Mode Markdown dans l’éditeur web Mintlify - - -
- ## Prochaines étapes -
- -* Apprenez les [concepts Git](/fr/guides/git-concepts) fondamentaux. -* Découvrez les meilleures pratiques de collaboration avec les [branches](/fr/guides/branches). -* Explorez la [gestion de contenu](/fr/editor/content-management) avec l’éditeur web. -* Comprenez les [options de publication](/fr/editor/publishing) selon différents scénarios. \ No newline at end of file diff --git a/fr/editor/keyboard-shortcuts.mdx b/fr/editor/keyboard-shortcuts.mdx deleted file mode 100644 index ff71acd8a..000000000 --- a/fr/editor/keyboard-shortcuts.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Raccourcis clavier" -description: "Raccourcis pour l’éditeur web" ---- - -L’éditeur web prend en charge tous les raccourcis clavier courants tels que copier, coller, annuler et tout sélectionner, ainsi que les raccourcis suivants : - -| Commande | macOS | Windows | -|:--------|:------|:--------| -| **Rechercher des fichiers** | Cmd + P | Control + P | -| **Ajouter un lien au texte sélectionné** | Cmd + K | Control + K | -| **Insérer un saut de ligne** | Cmd + Enter | Control + Enter | -| **Gras** | Cmd + B | Control + B | -| **Italique** | Cmd + I | Control + I | -| **Souligné** | Cmd + U | Control + U | -| **Barré** | Cmd + Shift + S | Control + Shift + S | -| **Code** | Cmd + E | Control + E | -| **Texte normal** | Cmd + Alt + 0 | Control + Alt + 0 | -| **Titre 1** | Cmd + Alt + 1 | Control + Alt + 1 | -| **Titre 2** | Cmd + Alt + 2 | Control + Alt + 2 | -| **Titre 3** | Cmd + Alt + 3 | Control + Alt + 3 | -| **Titre 4** | Cmd + Alt + 4 | Control + Alt + 4 | -| **Liste ordonnée** | Cmd + Shift + 7 | Control + Shift + 7 | -| **Liste à puces** | Cmd + Shift + 8 | Control + Shift + 8 | -| **Bloc de citation** | Cmd + Shift + B | Control + Shift + B | -| **Indice** | Cmd + , | Control + , | -| **Exposant** | Cmd + . | Control + . | \ No newline at end of file diff --git a/fr/editor/publishing.mdx b/fr/editor/publishing.mdx deleted file mode 100644 index 55fd139c1..000000000 --- a/fr/editor/publishing.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "Publication de vos modifications" -description: "Déployez les mises à jour de votre documentation directement en production ou via des pull requests" ---- - -La façon dont vos modifications sont publiées dépend de la branche sur laquelle vous travaillez : - -* **Branche de déploiement** : La publication met immédiatement à jour votre site en ligne. -* **Autres branches** : La publication crée une pull request (demande de fusion) afin que vous puissiez passer en revue les modifications avant leur déploiement en production. - - - Le bouton Publish mis en évidence dans l’éditeur web Mintlify - Le bouton Publish mis en évidence dans l’éditeur web Mintlify - - -
- ## Pull requests et revue des modifications -
- -Les pull requests (demandes de fusion) vous permettent de proposer des modifications depuis votre branche afin que d’autres puissent les revoir avant de les fusionner dans votre documentation en production. Cela permet de garantir que vos modifications sont correctes et offre à votre équipe l’occasion de collaborer sur le contenu. - - - Même si vous travaillez seul, les pull requests sont utiles pour prévisualiser les modifications et maintenir un historique clair des mises à jour. - - -
- ### Créer une pull request -
- - - - Assurez-vous que toutes vos modifications sont enregistrées sur votre branche en utilisant **Enregistrer les modifications**. - - - Sélectionnez **Publish Pull Request** dans le coin supérieur droit de l’éditeur. - - - Rédigez un titre et une description clairs expliquant : - - Les modifications que vous avez apportées - - Pourquoi vous les avez apportées - - Les points spécifiques nécessitant une relecture - - - Sélectionnez **Publish Pull Request**. L’éditeur fournira un lien pour afficher votre pull request. - - - Bouton Publish Pull Request mis en évidence dans l’éditeur web Mintlify - Bouton Publish Pull Request mis en évidence dans l’éditeur web Mintlify - - - - -
- ## Revue des pull requests -
- -Une fois votre pull request créée : - -1. **Passer en revue les modifications** : Vous et les membres de votre équipe pouvez examiner votre pull request dans votre fournisseur Git comme GitHub ou GitLab. -2. **Laisser des commentaires** : Ajoutez des commentaires ou demandez des modifications. -3. **Apporter des modifications supplémentaires** : Apportez des modifications supplémentaires dans l’éditeur web. Lorsque vous cliquez sur Enregistrer les modifications, l’éditeur les pousse vers votre pull request. -4. **Approuver** : Approuvez la pull request lorsque vous êtes satisfait des modifications. -5. **Fusionner** : Fusionnez la pull request lorsque vous êtes prêt à déployer vos modifications en production. \ No newline at end of file diff --git a/fr/editor/troubleshooting.mdx b/fr/editor/troubleshooting.mdx deleted file mode 100644 index 794e098ca..000000000 --- a/fr/editor/troubleshooting.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "Dépannage de l’éditeur web" -sidebarTitle: "Dépannage" -description: "Solutions aux problèmes courants" ---- - -Trouvez des solutions aux problèmes courants que vous pouvez rencontrer lors de l’utilisation de l’éditeur web. - - - - **Causes possibles :** - - * Le déploiement est toujours en cours - * Problèmes de cache du navigateur - * Erreurs de build ou de déploiement - - **Solutions :** - - 1. Vérifiez l’état du déploiement dans votre dashboard. - 2. Effectuez une actualisation forcée de votre navigateur (Ctrl + F5 ou Cmd + Shift + R) - 3. Videz le cache de votre navigateur. - - - - **Causes possibles :** - - * Permissions insuffisantes sur le référentiel Git - * Problèmes d’authentification avec votre fournisseur Git - - **Solutions :** - - 1. Vérifiez que vous disposez des accès adéquats au référentiel. - 2. Assurez-vous que votre intégration Git est correctement configurée. - 3. Consultez la documentation [Autorisations de l’éditeur](/fr/dashboard/permissions). - - - - **Causes possibles :** - - * Problèmes de connectivité réseau - * Référentiels de documentation volumineux - - **Solutions :** - - 1. Vérifiez votre connexion Internet. - 2. Actualisez la page. - 3. Contactez le support si le problème persiste. - - - - **Causes possibles :** - - * Syntaxe MDX invalide dans les fichiers - * Fichiers manquants ou corrompus - * Fichiers volumineux provoquant des expirations - - **Solutions :** - - 1. Vérifiez la syntaxe du fichier pour des erreurs de formatage MDX. - 2. Vérifiez que le fichier existe dans votre référentiel. - - \ No newline at end of file diff --git a/fr/index.mdx b/fr/index.mdx index 389415762..1e5b65f54 100644 --- a/fr/index.mdx +++ b/fr/index.mdx @@ -1,6 +1,6 @@ --- title: "Introduction" -description: "Découvrez la nouvelle génération de documentation. Native à l’IA, magnifique dès le départ et conçue pour les développeurs." +description: "Découvrez la nouvelle génération de documentation. Native à l’IA, magnifique dès la première utilisation et conçue pour les développeurs." mode: "frame" --- @@ -24,7 +24,7 @@ export const HeroCard = ({ filename, title, description, href }) => { };
-
+
Image d’arrière-plan décorative. Image d’arrière-plan décorative. @@ -36,11 +36,11 @@ export const HeroCard = ({ filename, title, description, href }) => {
- Découvrez la nouvelle génération de documentation. Native IA, superbe dès le départ, conçue pour les développeurs. + Découvrez la prochaine génération de documentation. Nativement propulsée par l’IA, élégante dès la première utilisation et conçue pour les développeurs.
- + diff --git a/fr/organize/pages.mdx b/fr/organize/pages.mdx index 7d5b2d44c..96685496c 100644 --- a/fr/organize/pages.mdx +++ b/fr/organize/pages.mdx @@ -95,7 +95,7 @@ mode: "wide" ### Personnalisé
-Le mode personnalisé offre une mise en page minimaliste qui supprime tous les éléments à l’exception de la barre de navigation supérieure. C’est une toile vierge pour créer des pages d’accueil ou toute autre mise en page unique nécessitant des éléments de navigation réduits au minimum. Le mode personnalisé est disponible pour tous les thèmes. +Le mode personnalisé propose une mise en page minimaliste qui supprime tous les éléments, à l’exception de la barre de navigation supérieure. C’est une toile blanche pour créer des pages de destination ou d’autres mises en page uniques lorsque vous souhaitez limiter les éléments de navigation. Le mode personnalisé est disponible pour tous les thèmes. ```yaml --- diff --git a/gt.config.json b/gt.config.json index 51690a6b4..462ad08db 100644 --- a/gt.config.json +++ b/gt.config.json @@ -62,6 +62,7 @@ "experimentalLocalizeStaticUrls": true, "docsHideDefaultLocaleImport": true, "experimentalHideDefaultLocale": true, - "experimentalAddHeaderAnchorIds": "mintlify" + "experimentalAddHeaderAnchorIds": "mintlify", + "experimentalClearLocaleDirs": true } } \ No newline at end of file diff --git a/zh/api/agent/create-agent-job.mdx b/zh/api/agent/create-agent-job.mdx index d90124387..d9732fe13 100644 --- a/zh/api/agent/create-agent-job.mdx +++ b/zh/api/agent/create-agent-job.mdx @@ -2,17 +2,17 @@ openapi: POST /agent/{projectId}/job --- -此端点会基于提供的消息和 branch 信息创建一个代理任务。该任务以异步方式执行，并通过流式响应返回执行详情和结果。 +此端点会根据提供的消息和 branch 信息创建一个代理任务。该任务异步执行，并以流式方式返回包含执行细节和结果的响应。 -如果某个 branch 不存在，代理会创建一个。若文件编辑成功，任务结束时会自动创建草稿拉取请求（PR；亦称“合并请求”/Merge Request）。 +如果某个 branch 不存在，代理将创建一个。若文件编辑成功，则会在任务结束时自动创建一条草稿拉取请求（PR；亦称“合并请求”/Merge Request）。
## 速率限制
-Agent API 具有以下限制： +代理 API 的限制如下： -- 每个 Mintlify 项目每小时最多 100 次调用 +- 每个 Mintlify 项目每小时最多可调用 100 次
## 建议用法 diff --git a/zh/api/agent/get-agent-job.mdx b/zh/api/agent/get-agent-job.mdx index eb893fdf3..b740f0dd8 100644 --- a/zh/api/agent/get-agent-job.mdx +++ b/zh/api/agent/get-agent-job.mdx @@ -6,7 +6,7 @@ openapi: GET /agent/{projectId}/job/{id} ## 用法
-此端点可通过唯一标识符获取特定代理任务的详细信息与状态。可用于查看之前创建的代理任务的进度、状态和结果。 +此端点通过代理任务的唯一标识符获取该任务的详细信息和状态。可用于查看先前创建的代理任务的进度、状态和结果。
## 作业详情 @@ -15,5 +15,5 @@ openapi: GET /agent/{projectId}/job/{id} 响应包含以下信息： - 作业执行状态与完成情况 -- branch 信息与拉取请求（PR；亦称“合并请求”/Merge Request）详情 +- branch 信息和拉取请求（PR；亦称“合并请求”/Merge Request）详情 - 会话 metadata 与时间戳 \ No newline at end of file diff --git a/zh/api/agent/get-all-jobs.mdx b/zh/api/agent/get-all-jobs.mdx index fc5ba5fd2..7ca990d12 100644 --- a/zh/api/agent/get-all-jobs.mdx +++ b/zh/api/agent/get-all-jobs.mdx @@ -6,10 +6,10 @@ openapi: GET /agent/{projectId}/jobs ## 用法
-此端点会检索指定 domain 的所有代理任务，提供代理活动及其当前状态的总体概览。适用于监控和管理并发或历史的多项代理任务。 +该端点会检索指定 domain 的所有代理任务，概览所有代理活动及其当前状态。适用于监控和管理多个并发或历史代理任务。
## 响应
-使用此端点获取所有以往代理会话的完整概览。 \ No newline at end of file +使用此端点可获取所有历史代理会话的完整概览。 \ No newline at end of file diff --git a/zh/api/assistant/create-assistant-message.mdx b/zh/api/assistant/create-assistant-message.mdx index 0497bce93..d185e0ad1 100644 --- a/zh/api/assistant/create-assistant-message.mdx +++ b/zh/api/assistant/create-assistant-message.mdx @@ -2,8 +2,6 @@ openapi: POST /assistant/{domain}/message --- - -
## 速率限制
@@ -12,9 +10,7 @@ AI 助手 API 的限制如下： - 每个 key 每月最多使用 10,000 次 - 每个 Mintlify 组织每小时最多 10,000 次请求 -- 每个 IP 每天最多 10,000 次请求 - - +- 每个 IP 每日最多 10,000 次请求
## 建议用法 @@ -22,4 +18,4 @@ AI 助手 API 的限制如下： 为获得最佳效果，请使用 [ai-sdk 的 useChat 钩子](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) 来发送请求并处理响应。 -你可以在传递给该钩子的选项参数的 `body` 字段中设置 `fp`、`threadId` 和 `filter`。 \ No newline at end of file +你可以在传递给该钩子的 options 参数中，通过 `body` 字段设置 `fp`、`threadId` 和 `filter`。 \ No newline at end of file diff --git a/zh/api/assistant/create-topic.mdx b/zh/api/assistant/create-topic.mdx index dc00663e3..30ad8b74f 100644 --- a/zh/api/assistant/create-topic.mdx +++ b/zh/api/assistant/create-topic.mdx @@ -1,3 +1,3 @@ --- openapi: POST /chat/topic ---- +--- \ No newline at end of file diff --git a/zh/api/assistant/generate-message.mdx b/zh/api/assistant/generate-message.mdx index b1cdbbb37..30a74c542 100644 --- a/zh/api/assistant/generate-message.mdx +++ b/zh/api/assistant/generate-message.mdx @@ -1,3 +1,3 @@ --- openapi: POST /chat/message ---- +--- \ No newline at end of file diff --git a/zh/api/assistant/search.mdx b/zh/api/assistant/search.mdx index aad5f0e85..d0c97a8da 100644 --- a/zh/api/assistant/search.mdx +++ b/zh/api/assistant/search.mdx @@ -1,3 +1,3 @@ --- openapi: "POST /search/{domain}" ---- +--- \ No newline at end of file diff --git a/zh/api/introduction.mdx b/zh/api/introduction.mdx index 8e8a6bd13..8c1a8d3a3 100644 --- a/zh/api/introduction.mdx +++ b/zh/api/introduction.mdx @@ -3,25 +3,25 @@ title: "简介" description: "触发更新、嵌入 AI 助手等" --- -Mintlify 的 REST API 让你可以以编程方式与文档交互、触发更新，并嵌入 AI 驱动的聊天体验。 +Mintlify 的 REST API 使你能够以编程方式与文档交互、触发更新，并嵌入 AI 驱动的聊天体验。
## 端点
* [触发更新](/zh/api-reference/update/trigger): 按需触发你的网站更新。 -* [获取更新状态](/zh/api-reference/update/status): 获取更新状态及与你的文档相关的其他详情。 +* [获取更新状态](/zh/api-reference/update/status): 获取一次更新的状态以及你文档的其他详细信息。 * [创建代理任务](/zh/api-reference/agent/create-agent-job): 创建代理任务以自动编辑你的文档。 -* [获取代理任务](/zh/api-reference/agent/get-agent-job): 获取特定代理任务的详情和状态。 -* [获取所有代理任务](/zh/api-reference/agent/get-all-jobs): 检索某个 domain 下的所有代理任务。 -* [生成 AI 助手消息](/zh/api-reference/assistant/create-assistant-message): 将基于你文档训练的 AI 助手嵌入到任意应用中。 -* [搜索文档](/zh/api-reference/assistant/search): 在文档中搜索。 +* [获取代理任务](/zh/api-reference/agent/get-agent-job): 获取特定代理任务的详细信息和状态。 +* [获取所有代理任务](/zh/api-reference/agent/get-all-jobs): 获取某个 domain 的所有代理任务。 +* [生成 AI 助手消息](/zh/api-reference/assistant/create-assistant-message): 将基于你的文档训练的 AI 助手嵌入到任意应用中。 +* [搜索文档](/zh/api-reference/assistant/search): 在你的文档中进行搜索。
## 认证
-您可以通过[控制台](https://dashboard.mintlify.com/settings/organization/api-keys)生成 API key。API key 关联整个组织，可在多个部署中使用。 +你可以通过[控制台](https://dashboard.mintlify.com/settings/organization/api-keys)生成 API key。API key 与整个组织关联，可在多个部署中使用。
### 管理员 API key @@ -29,7 +29,7 @@ Mintlify 的 REST API 让你可以以编程方式与文档交互、触发更新 管理员 API key 用于 [触发更新](/zh/api-reference/update/trigger)、[获取更新状态](/zh/api-reference/update/status) 以及所有代理端点。 -管理员 API key 以 `mint_` 作为前缀。请妥善保管你的管理员 API key。 +管理员 API key 以 `mint_` 前缀开头。请妥善保管你的管理员 API key。
### Assistant API key @@ -37,12 +37,12 @@ Mintlify 的 REST API 让你可以以编程方式与文档交互、触发更新 assistant API key 用于 [生成助手消息](/zh/api-reference/assistant/create-assistant-message) 和 [搜索文档](/zh/api-reference/assistant/search) 端点。 -Assistant API key 以 `mint_dsc_` 前缀开头。 +assistant API key 以 `mint_dsc_` 前缀开头。 assistant API 的 **key** 是应当保密的服务端令牌。 assistant API 的 **token** 是可在前端代码中引用的公共令牌。 - 使用 assistant API token 的调用可能会产生费用：要么消耗你的 AI 助手额度，要么产生超额费用。 + 使用 assistant API token 进行的调用可能会产生费用：可能会消耗你的 AI 助手额度，或产生超额费用。 \ No newline at end of file diff --git a/zh/api/update/status.mdx b/zh/api/update/status.mdx index 9e2e93b66..1ea0b419a 100644 --- a/zh/api/update/status.mdx +++ b/zh/api/update/status.mdx @@ -1,3 +1,3 @@ --- openapi: "GET /project/update-status/{statusId}" ---- +--- \ No newline at end of file diff --git a/zh/api/update/trigger.mdx b/zh/api/update/trigger.mdx index 26b0968f3..e4d85f180 100644 --- a/zh/api/update/trigger.mdx +++ b/zh/api/update/trigger.mdx @@ -1,3 +1,3 @@ --- openapi: "POST /project/update/{projectId}" ---- +--- \ No newline at end of file diff --git a/zh/changelog.mdx b/zh/changelog.mdx index f5526e585..ebb378d7e 100644 --- a/zh/changelog.mdx +++ b/zh/changelog.mdx @@ -5,91 +5,132 @@ rss: true noindex: true --- - + + ## 新功能 + + * 产品导航：通过产品切换器为多个产品的文档进行组织 + * 无障碍命令行（CLI）命令：运行 `mint a11y` 测试文档的无障碍问题 + * API 操作台视频响应：API 操作台现已支持显示视频响应类型 + * API 操作台预填：新增预填示例选项，加速 API 操作台测试 + * 未认证反馈：在启用部分认证的网站中，未登录用户也可提交反馈 + * 支持 Shiki 主题：现已支持使用 Shiki 主题美化代码块样式 + * 代码块的 Twoslash：TypeScript 与 JavaScript 代码块现支持 Twoslash 内联类型信息 + + ## 无障碍改进 + + * 在各组件中补充完善 ARIA 属性，以更好地支持屏幕阅读器 + * 新增“跳至主内容”按钮，优化键盘导航 + * Tab 组件支持方向键导航 + * 提升了工具提示、嵌套列表与代码组的无障碍性 + * 全局改进焦点状态与键盘交互模式 + + ## AI 助手与 Analytics 增强 + + * 为 AI 助手的 query 分析新增柱状图可视化 + * 在 AI 助手 Analytics 页面统一了日期范围选择器 + * 为 AI 助手 Analytics 图表提供缩放控件 + * 通过快捷键与聊天抽屉等优化改进 AI 助手历史记录管理 + + ## 缺陷修复与可靠性 + + * 修复了侧边面板遮罩的 z-index 问题 + * 修复了 light 模式的颜色回退与主题相关样式问题 + * 修复了 API 操作台可展开项与锚点链接不兼容的问题 + * 修复了 ChatGPT 与其他 LLM 代理对 `.md` 链接的可访问性问题 + * 修复了按百分比设置宽度与高度的图像尺寸处理 + * 修复了带语言标签与自定义主题的代码块渲染问题 + * 修复了折叠面板链接的格式与样式 + * 修复了在 AI 助手配置为空时页脚的间距问题 + * 修复了本地存储库图像的卡片 icon 渲染 + * 修复了 API 操作台中的音频文件处理（避免 UTF-8 解码） + * 改进了网页版编辑器中的 PR 发布状态管理 + + + ## 语言支持扩展 - * 在文档界面中新增对罗马尼亚语和捷克语的支持 - * 增强本地化能力，为新语言提供完整翻译覆盖 - * 改进所有主题中的语言选择器功能 + * 在文档界面中新增对罗马尼亚语与捷克语的支持 + * 加强本地化能力，为新语言提供完整的翻译覆盖 + * 改进了所有主题中的语言选择器功能 - ## UI 与用户体验改进 + ## 界面与用户体验改进 - * 修复 404 页面上的标签页可见性问题，防止错误的激活标签页高亮 - * 改进非优化图像的处理，正确传递 width 和 height 属性 - * 改善 404 页面的布局与样式一致性 + * 修复了 404 页面上的标签页可见性问题，避免错误的活动标签页高亮 + * 加强图像处理，为未优化图像正确传递 width 与 height 属性 + * 改进了 404 页面的布局与样式一致性 ## 基础设施与性能增强 - * 通过跳过代价高昂的 Imgix 自动格式化来增强 GIF 图像处理，减少处理时间和带宽占用 - * 通过针对动画内容的特殊处理来优化图像服务性能 + * 通过跳过成本较高的 Imgix 自动格式化，增强了 GIF 图像处理，降低处理时间与带宽占用 + * 通过对动图的专项处理优化了图像分发性能 ## 缺陷修复与可靠性 - * 修复控制台设置中 AI 助手附加组件请求的联系邮箱路由 - * 增强数据库架构更新以改善用户管理 + * 修复了控制台设置中用于 Assistant 附加组件请求的联系邮箱路由 + * 加强了数据库架构更新，改进用户管理 - + ## GitLab 集成增强 - * 在控制台设置中增强 GitLab 连接 UI，便于存储库管理 - * 新增 webhook 支持，在 GitLab 提交时自动更新文档 + * 在控制台设置中优化了 GitLab 连接界面，便于更轻松地管理存储库 + * 新增 webhook 支持，以在 GitLab 提交时自动更新文档 - ## Web 编辑器与认证改进 + ## 网页编辑器与认证改进 - * 持续推进 Web 编辑器的应用路由迁移，移除阻碍并提升性能 - * 增强登录错误处理，提供明确的邮箱校验消息 - * 修复邮箱地址校验中的空白字符处理 + * 持续推进网页编辑器的应用路由迁移，移除阻碍并提升性能 + * 加强登录错误处理，提供明确的邮箱验证消息 + * 修复了邮箱地址验证中的空白字符处理 ## 缺陷修复与可靠性 - * 修复应用路由的 socket 更新功能以支持实时特性 - * 修复文档中的 SVG 路径渲染问题 - * 修复搜索与聊天功能中的键盘导航 - * 修复历史状态端点的可靠性 - * 解决中间件边界情况与 onClick 事件处理问题 + * 修复了应用路由的 socket 更新功能，以支持实时特性 + * 修复了文档中的 SVG 路径渲染问题 + * 修复了搜索与聊天功能中的键盘导航 + * 提升了历史状态端点的可靠性 + * 解决了中间件边界情况与 onClick 事件处理问题 - - ## 重要发布 + + ## 重大更新 - * 重大增强：在 404 页面提供 AI 推荐页面，[当用户点击失效链接 → AI 代理读取路径 → 推荐语义相似的页面](https://x.com/mintlify/status/1966625627773059495) - * 重大发布：AI 助手的网页搜索现可包含外部来源\ - 注：如需为你的网站启用此功能，请联系我们。 + * **重要增强**：在 404 页面提供 AI 推荐，[当有人访问失效链接 → AI 代理解析路径 → 推荐语义相近的页面](https://x.com/mintlify/status/1966625627773059495) + * **重大发布**：AI 助手的网页搜索现在可包含外部来源\ + *注意：如需为你的站点启用此功能，请联系我们。* ## AI 助手与 MCP - * 修复由于时间窗口未正确滑动而导致 AI 助手被错误限流的问题 - * 修复 AI 助手工具调用，正确处理空的 `text` 块 - * 修复 MCP 服务器名称与工具调用拼接后有时超过 MCP 客户端强制的 60 字符长度的问题 - * 修复 AI 助手菜单高度远超视口并无限滚动的问题 - * 修复控制台中 AI 助手花费值显示超过两位小数的问题 + * 修复了因时间窗口未正确滑动而导致 AI 助手被错误限流的问题 + * 修复了 AI 助手在工具调用中处理空 `text` 块的错误 + * 修复了 MCP 服务器名称与工具调用拼接后有时会超过 MCP 客户端强制的 60 个字符限制的问题 + * 修复了 AI 助手菜单的 height 远大于视口并导致无限滚动的问题 + * 修复了控制台中 AI 助手花费金额可能显示超过两位小数的问题 - ## Web 编辑器与部署 + ## 网页编辑器与部署 - * 为编辑器新增安全增强：仅允许对连接的 Git 托管存储库拥有 `write permissions` 的用户进行更改 - * 修复预览部署在名称包含 `=` 的 branch 上无法工作的问题 - * 修复较长 branch 名称在创建预览部署的模态框中溢出的问题 - * 体验优化：在注册邀请中，email query 参数将预填输入框 - * 修复在 Safari 中从上下文菜单复制页面不起作用的问题 + * 新增安全增强：仅对关联的 Git 托管存储库具有 `write permissions` 的用户才能在编辑器中进行更改 + * 修复了名称中包含 `=` 的 branch 无法创建预览部署的问题 + * 修复了过长的 branch 名称在创建预览部署时会溢出模态框的问题 + * 体验优化：注册邀请中，email query 参数将预填输入框 + * 修复了在 Safari 上通过上下文菜单复制页面无效的问题 ## API 操作台与导航 - * 多个 API 操作台响应码现在在聚焦时显示为受控样式的选择菜单，而非系统默认选择菜单 - * 你现在可以使用 [`docs.json` 中导航 groups 的 `expanded` 字段使其默认展开](https://mintlify.com/docs/navigation#default-expanded-state) + * 多个 API 操作台响应码在聚焦时现以受控的样式化选择菜单显示，而非系统默认选择菜单 + * 你现在可以在 `docs.json` 的导航 groups 中使用 [`expanded` 字段使其默认展开](https://mintlify.com/docs/navigation#default-expanded-state) - ## SEO 与 UI + ## SEO 与界面 - * 修复 favicon 在搜索引擎中不显示的问题，改为从与各文档站点相同的 URL 提供 - * 修复 YouTube 嵌入在加载时闪烁的问题 - * 修复展开反馈菜单以包含书面反馈时导致目录布局偏移的问题 - * 修复在 Maple 主题中关闭通知横幅后文本会溢出到顶栏上方的问题 - * 在 Maple 和 Willow 主题的侧边栏中新增登录/登出按钮，提升使用便捷性 + * 通过从与各文档站相同的 URL 提供 favicon，修复了搜索引擎中不显示站点图标的问题 + * 修复了 YouTube 嵌入在加载时闪烁的问题 + * 修复了将反馈菜单扩展为包含文字回复时与目录之间出现布局位移的问题 + * 修复了在 Maple 主题中关闭通知横幅后文本溢出到顶栏上方的问题 + * 优化了 Maple 与 Willow 主题，在侧边栏新增登录/登出按钮，便于访问 ## Analytics 与导出 - * 修复 AI 助手分析视图与导出的可靠性问题 - * AI 助手分析导出现改为后台执行并通过电子邮件发送，提供更可靠的体验 + * 修复了 AI 助手分析视图与导出的可靠性问题 + * AI 助手分析导出现改为在后台执行，并通过电子邮件发送，以提供更稳定可靠的体验 diff --git a/zh/customize/themes.mdx b/zh/customize/themes.mdx index b2fec4f86..35f1ce279 100644 --- a/zh/customize/themes.mdx +++ b/zh/customize/themes.mdx @@ -1,6 +1,6 @@ --- title: "主题" -description: "自定义文档的外观" +description: "自定义文档外观" mode: "frame" --- @@ -14,12 +14,12 @@ export const ThemeCard = ({ title, value, description, href }) => {

{title}

- +
{description}
- 查看示例 + 查看预览 @@ -33,23 +33,23 @@ export const ThemeCard = ({ title, value, description, href }) => {

主题

- +
- + - + - + - + - + - + - +
diff --git a/zh/editor/content-management.mdx b/zh/editor/content-management.mdx deleted file mode 100644 index 3471b5630..000000000 --- a/zh/editor/content-management.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: "管理内容" -description: "创建、编辑和组织文档页面" ---- - - - -使用侧边栏的文件浏览器浏览文档。点击任意文件即可在编辑器中打开。 - -按 Command + P（Windows 上为 Ctrl + P）可按名称搜索文件。 - -
- ## 创建新页面 -
- - - - 在文件资源管理器侧边栏中选择“新建文件”图标。 - - 网页版编辑器中的文件菜单 - 深色模式下网页版编辑器中的文件菜单 - - - 文件名必须以 `.mdx` 结尾。例如：`api-reference.mdx` 或 `getting-started.mdx`。 - - - 按 Enter 创建文件。它会自动在编辑器中打开，随时可添加内容。 - - - -
- ## 组织导航 -
- -通过编辑 `docs.json` 文件，将新页面添加到站点导航中。 - - - - 使用文件资源管理器在项目根目录中找到并打开 `docs.json` 文件。 - - - 在 `docs.json` 文件中找到你希望添加新页面的位置。 - - - 在相应分组的 `pages` 数组中插入页面文件名（不含 `.mdx` 扩展名）。 - - - -
- ### 示例：添加一个主题页面 -
- -```json title="Adding a themes page to the Profile group" highlight="18" -{ - "navigation": { - "groups": [ - { - "group": "开始使用", - "pages": [ - "index", - "quickstart", - "installation" - ] - }, - { - "group": "个人资料", - "pages": [ - "settings", - "account-types", - "dashboard", - "themes" - ] - } - ] - } -} -``` - - -
- ## 编辑内容 -
- -在编辑器中使用可视化模式或 Markdown 模式修改页面。 - -在可视化模式下，按 / 打开组件菜单。添加内容块、提示框、代码块等组件，定制你的文档。 - - - Mintlify 网页编辑器中展开并高亮的组件菜单 - Mintlify 网页编辑器中展开并高亮的组件菜单 - - -在 Markdown 模式下，你可以直接编辑页面的 `MDX`。在以下情况下会很有帮助： - -- 设置特定的组件属性 -- 处理复杂的嵌套组件 -- 从其他来源复制并粘贴 `MDX` 内容 \ No newline at end of file diff --git a/zh/editor/getting-started.mdx b/zh/editor/getting-started.mdx deleted file mode 100644 index 83daa1556..000000000 --- a/zh/editor/getting-started.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "使用网页版编辑器入门" -sidebarTitle: "入门" -description: "了解如何使用网页版编辑器创建和编辑文档" ---- - -浅色模式下的 Mintlify 网页版编辑器界面 - -深色模式下的 Mintlify 网页版编辑器界面 - -网页版编辑器是在浏览器中直接用于创建、编辑和审阅文档的可视化界面。 - -* **可视化编辑**：使用 WYSIWYG（所见即所得）编辑器修改文档，所见即发布效果。 -* **Git 同步**：所有更改会自动与您的 Git 存储库同步，确保版本控制。 -* **团队协作**：支持多人同时编辑文档。 -* **组件集成**：通过斜杠命令快速添加提示、代码块等组件。 -* **无需配置**：从控制台即可立即开始写作。 - -
- ## Web 编辑器工作流 -
- -以下是在 Web 编辑器中的典型工作方式： - - - - 创建一个 branch，或直接在你的部署用分支上修改。我们建议创建一个 branch，这样你可以在更改上线前先预览。 - - - - 在侧边栏找到现有文件，或通过文件资源管理器新建文件。 - - - - 在 Web 编辑器中进行修改。尝试使用右上角的切换按钮在可视化模式和 Markdown 模式之间切换，看看你更喜欢哪种模式。 - - - - 可视化模式会显示你的更改在上线站点上的呈现效果。用它来检查一切是否正确。 - - - - 如果你在部署用分支上工作，可直接从 Web 编辑器发布更改。对于其他 branch，你需要创建一个拉取请求（PR；亦称“合并请求”/Merge Request），在发布前进行审查。 - - - -
- ## 编辑器模式 -
- -Web 编辑器提供两种模式，以满足不同的编辑偏好和需求。使用编辑器工具栏右上角的切换按钮在两种模式间切换。 - - - Web 编辑器中高亮显示的模式切换图标。 - - Web 编辑器中高亮显示的模式切换图标。 - - -
- ### 可视化模式 -
- -可视化模式提供 WYSIWYG（所见即所得）体验：你在编辑器中所做的更改将与发布到文档站点的效果完全一致。此模式非常适合希望实时查看更改呈现效果的场景。 - -按下“/”打开组件菜单，添加样式化内容、提醒、代码片段或其他组件。 - - - Mintlify 网页编辑器中的可视化编辑模式 - - Mintlify 网页编辑器中的可视化编辑模式 - - -
- ### Markdown 模式 -
- -Markdown 模式可直接访问文档的底层 `MDX` 代码。该模式适用于需要精确控制组件属性，或偏好使用 Markdown 语法编写内容的场景。 - - - Mintlify 网页编辑器中的 Markdown 模式 - - Mintlify 网页编辑器中的 Markdown 模式 - - -
- ## 后续步骤 -
- -* 学习 [Git 概念](/zh/guides/git-concepts) 基础。 -* 学习使用 [branch](/zh/guides/branches) 协作的最佳实践。 -* 使用网页版编辑器探索 [内容管理](/zh/editor/content-management)。 -* 了解适用于不同场景的 [发布选项](/zh/editor/publishing)。 \ No newline at end of file diff --git a/zh/editor/keyboard-shortcuts.mdx b/zh/editor/keyboard-shortcuts.mdx deleted file mode 100644 index 8ef3dd009..000000000 --- a/zh/editor/keyboard-shortcuts.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "键盘快捷键" -description: "Web 编辑器的快捷键" ---- - -Web 编辑器支持所有常见的键盘快捷键，如复制、粘贴、撤销和全选，以及以下快捷键： - -| 命令 | macOS | Windows | -|:--------|:------|:--------| -| **搜索文件** | Cmd + P | Control + P | -| **为选中文本添加链接** | Cmd + K | Control + K | -| **插入换行** | Cmd + Enter | Control + Enter | -| **加粗** | Cmd + B | Control + B | -| **斜体** | Cmd + I | Control + I | -| **下划线** | Cmd + U | Control + U | -| **删除线** | Cmd + Shift + S | Control + Shift + S | -| **行内代码** | Cmd + E | Control + E | -| **正文** | Cmd + Alt + 0 | Control + Alt + 0 | -| **标题 1** | Cmd + Alt + 1 | Control + Alt + 1 | -| **标题 2** | Cmd + Alt + 2 | Control + Alt + 2 | -| **标题 3** | Cmd + Alt + 3 | Control + Alt + 3 | -| **标题 4** | Cmd + Alt + 4 | Control + Alt + 4 | -| **有序列表** | Cmd + Shift + 7 | Control + Shift + 7 | -| **无序列表** | Cmd + Shift + 8 | Control + Shift + 8 | -| **引用块** | Cmd + Shift + B | Control + Shift + B | -| **下标** | Cmd + , | Control + , | -| **上标** | Cmd + . | Control + . | \ No newline at end of file diff --git a/zh/editor/publishing.mdx b/zh/editor/publishing.mdx deleted file mode 100644 index 355fcdd90..000000000 --- a/zh/editor/publishing.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "发布你的更改" -description: "直接将文档更新部署到生产环境，或通过拉取请求进行发布" ---- - -更改的发布方式取决于你当前所在的 branch： - -* **部署用分支**：发布会立即更新你的线上站点。 -* **其他分支**：发布会创建一个拉取请求（PR；亦称“合并请求”/Merge Request），以便你在部署到生产环境之前审阅更改。 - - - Mintlify 网页编辑器中被突出显示的“发布”按钮 - Mintlify 网页编辑器中被突出显示的“发布”按钮 - - -
- ## 拉取请求（PR；亦称“合并请求”/Merge Request）与变更审查 -
- -拉取请求允许你从自己的 branch 提交更改，便于他人在合并到线上文档之前进行审查。这样有助于确保更改的准确性，并为团队协作完善内容提供机会。 - - - 即使你独自工作，拉取请求也有助于预览更改并维护清晰的更新历史。 - - -
- ### 创建拉取请求（pull request） -
- - - - 确保你所有的更改已通过 **保存更改** 提交到你的 branch。 - - - 在编辑器右上角选择 **Publish Pull Request**。 - - - 撰写清晰的标题和说明，说明： - - 你做了哪些更改 - - 你为什么进行这些更改 - - 有哪些需要重点审查的部分 - - - 选择 **Publish Pull Request**。编辑器会提供一个链接以查看你的拉取请求。 - - - Mintlify 网页编辑器中突出显示的 Publish Pull Request 按钮 - Mintlify 网页编辑器中突出显示的 Publish Pull Request 按钮 - - - - -
- ## 审查拉取请求（PR） -
- -创建拉取请求后： - -1. **审阅更改**：你和团队成员可以在 Git 提供商（如 GitHub 或 GitLab）中审阅你的拉取请求。 -2. **留下反馈**：添加评论或请求更改。 -3. **进行进一步更改**：在网页编辑器中继续修改。点击“保存更改”后，编辑器会将更新推送到你的拉取请求。 -4. **批准**：对更改满意后，批准该拉取请求。 -5. **合并**：准备将更改部署到生产环境时，合并该拉取请求。 \ No newline at end of file diff --git a/zh/editor/troubleshooting.mdx b/zh/editor/troubleshooting.mdx deleted file mode 100644 index 988045068..000000000 --- a/zh/editor/troubleshooting.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "排查 Web 编辑器问题" -sidebarTitle: "问题排查" -description: "常见问题的解决方案" ---- - -查找使用 Web 编辑器时可能遇到的常见问题的解决方案。 - - - - **可能原因：** - - * 部署仍在进行 - * 浏览器缓存问题 - * 构建或部署出错 - - **解决方案：** - - 1. 在控制台查看部署状态。 - 2. 强制刷新浏览器（Ctrl + F5 或 Cmd + Shift + R） - 3. 清除浏览器缓存。 - - - - **可能原因：** - - * 对 Git 存储库的权限不足 - * 与 Git 提供商的认证问题 - - **解决方案：** - - 1. 确认你对该存储库具有正确的访问权限。 - 2. 检查你的 Git 集成是否已正确配置。 - 3. 查看 [编辑器权限](/zh/dashboard/permissions) 文档。 - - - - **可能原因：** - - * 网络连接问题 - * 文档存储库体量较大 - - **解决方案：** - - 1. 检查你的网络连接。 - 2. 刷新页面。 - 3. 若问题仍然存在，请联系支持。 - - - - **可能原因：** - - * 文件中的 MDX 语法无效 - * 文件缺失或损坏 - * 大文件导致超时 - - **解决方案：** - - 1. 检查文件语法是否存在 MDX 格式错误。 - 2. 确认该文件已在你的存储库中。 - - \ No newline at end of file diff --git a/zh/index.mdx b/zh/index.mdx index f6fbe89e4..46434c78c 100644 --- a/zh/index.mdx +++ b/zh/index.mdx @@ -1,6 +1,6 @@ --- title: "简介" -description: "邂逅新一代文档：AI 原生、开箱即用且美观，为开发者打造。" +description: "邂逅新一代文档：AI 原生、开箱即美观，为开发者而生。" mode: "frame" --- @@ -24,7 +24,7 @@ export const HeroCard = ({ filename, title, description, href }) => { };
-
+
装饰性背景图像。 装饰性背景图像。 @@ -36,17 +36,17 @@ export const HeroCard = ({ filename, title, description, href }) => {
- 迎接新一代文档：原生 AI、开箱即用的精美体验，为开发者而生。 + 迎接新一代文档：原生 AI、开箱即用且优雅，为开发者而生。
- + - + - + - +
diff --git a/zh/organize/pages.mdx b/zh/organize/pages.mdx index df9a3f05c..4bf23df4c 100644 --- a/zh/organize/pages.mdx +++ b/zh/organize/pages.mdx @@ -95,7 +95,7 @@ mode: "wide" ### 自定义
-自定义模式提供极简布局，除顶部导航栏外移除所有元素。它是一块空白画布，适合创建登录页或其他希望尽可能精简导航元素的独特布局。所有主题均支持自定义模式。 +自定义模式提供极简布局，只保留顶部导航栏。它是一块空白画布，可用于创建登录页或其他任何独特布局，适用于希望尽量减少导航元素的场景。自定义模式适用于所有主题。 ```yaml ---