diff --git a/es/api-playground/overview.mdx b/es/api-playground/overview.mdx index 2df1c4cdf..a45681ed5 100644 --- a/es/api-playground/overview.mdx +++ b/es/api-playground/overview.mdx @@ -96,7 +96,9 @@ Personaliza tu área de pruebas de la API definiendo las siguientes propiedades - Indica si las solicitudes de API deben pasar por un servidor proxy. El valor predeterminado es `true`. + Indica si las solicitudes de API deben pasar por el servidor proxy de Mintlify. El valor predeterminado es `true`. + + Cuando es `true`, las solicitudes del área de pruebas se enrutan a través de los servidores de Mintlify. Cuando es `false`, el área de pruebas envía las solicitudes directamente desde el navegador a tu API. Establécelo en `false` cuando tu API acepte solicitudes directas desde el navegador y no necesites que Mintlify actúe como proxy del tráfico. Por ejemplo, cuando tu API requiere encabezados específicos que no pueden reenviarse a través del proxy o cuando necesitas que la solicitud se origine directamente desde el navegador del usuario con fines de autenticación. @@ -115,26 +117,26 @@ Personaliza tu área de pruebas de la API definiendo las siguientes propiedades Se muestran en el orden especificado. - | Nombre visible | Clave | Alias | - | --- | --- | --- | - | cURL | `bash` | `curl`, `sh`, `shell` | - | Python | `python` | `py` | - | JavaScript | `javascript` | `js` | - | Node.js | `node` | `nodejs`, `node.js` | - | PHP | `php` | | - | Go | `go` | `golang` | - | Java | `java` | | - | Ruby | `ruby` | `rb` | - | PowerShell | `powershell` | | - | Swift | `swift` | | - | C# | `csharp` | `c#` | - | .NET | `dotnet` | `.net`, `.NET`, `dot-net` | - | TypeScript | `typescript` | `ts` | - | C | `c` | | - | C++ | `c++` | `cpp` | - | Kotlin | `kotlin` | `kt` | - | Rust | `rust` | `rs` | - | Dart | `dart` | `flutter` | + | Nombre visible | Clave | Alias | + | -------------- | ------------ | ------------------------- | + | cURL | `bash` | `curl`, `sh`, `shell` | + | Python | `python` | `py` | + | JavaScript | `javascript` | `js` | + | Node.js | `node` | `nodejs`, `node.js` | + | PHP | `php` | | + | Go | `go` | `golang` | + | Java | `java` | | + | Ruby | `ruby` | `rb` | + | PowerShell | `powershell` | | + | Swift | `swift` | | + | C# | `csharp` | `c#` | + | .NET | `dotnet` | `.net`, `.NET`, `dot-net` | + | TypeScript | `typescript` | `ts` | + | C | `c` | | + | C++ | `c++` | `cpp` | + | Kotlin | `kotlin` | `kt` | + | Rust | `rust` | `rs` | + | Dart | `dart` | `flutter` | @@ -224,6 +226,17 @@ Se recomienda la extensión `x-mint` para que toda la documentación de tu API s Las páginas MDX individuales se recomiendan para APIs pequeñas o cuando quieras experimentar con cambios página por página. +
+ ## Visualización de respuestas +
+ +El playground renderiza automáticamente las respuestas según el encabezado `Content-Type` que devuelve tu API. + +* **Imágenes**: Se renderizan en línea (`image/*`). +* **Audio**: Se renderiza con un reproductor de audio integrado (`audio/*`). +* **Video**: Se renderiza con un reproductor de video integrado (`video/*`). Cualquier respuesta con un tipo de contenido `video/*`, como `video/mp4` o `video/webm`, se muestra como un video reproducible directamente en el playground. +* **Todas las demás respuestas**: Se muestran en un bloque de código. +
## Más información
diff --git a/es/deploy/authentication-setup.mdx b/es/deploy/authentication-setup.mdx index eea9aec29..557c0f9ef 100644 --- a/es/deploy/authentication-setup.mdx +++ b/es/deploy/authentication-setup.mdx @@ -11,12 +11,12 @@ keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password'] - La autenticación solo está disponible para documentación alojada en un dominio personalizado o subdominio de Mintlify (por ejemplo, `docs.ejemplo.com` o `ejemplo.mintlify.dev`). La autenticación **no es compatible** cuando se usa una [ruta base personalizada](/es/deploy/docs-subpath) (por ejemplo, `ejemplo.com/docs`). + La autenticación solo está disponible para documentación alojada en un dominio personalizado o subdominio de Mintlify (por ejemplo, `docs.example.com` o `example.mintlify.dev`). La autenticación **no es compatible** cuando se usa una [ruta base personalizada](/es/deploy/docs-subpath) (por ejemplo, `example.com/docs`). La autenticación exige que los usuarios inicien sesión antes de acceder a tu documentación. -Cuando habilites la autenticación, los usuarios deberán iniciar sesión para acceder a cualquier contenido. Puedes configurar páginas o grupos específicos como públicos mientras mantienes otras páginas protegidas. +Cuando habilites la autenticación, los usuarios deberán iniciar sesión para acceder a cualquier contenido. Puedes configurar páginas específicas o groups como públicos mientras mantienes otras páginas protegidas.
## Configurar la autenticación @@ -489,19 +489,19 @@ Cuando utilices autenticación OAuth o JWT, tu sistema devolverá datos de usuar
- ## Disponibilidad de funciones + ## Disponibilidad de funcionalidades
-Algunas funciones se comportan de manera diferente o no están disponibles cuando habilitas la autenticación. - -| Función | Público | Totalmente autenticado (todas las páginas protegidas) | Parcialmente autenticado (algunas páginas públicas) | -| :----------------------------------------------------------- | :---------------------- | :--------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | -| [llms.txt and llms-full.txt](/es/ai/llmstxt) | Compatibilidad completa | Disponible tras autenticación, por lo que es posible que las herramientas de IA no puedan acceder a los archivos | Disponible tras autenticación, por lo que es posible que las herramientas de IA no puedan acceder a los archivos | -| [Servidor MCP](/es/ai/model-context-protocol) | Compatibilidad completa | Requiere autenticación para conectarse | Disponible sin autenticación para páginas públicas y con autenticación para páginas protegidas | -| [Exportación a Markdown](/es/ai/markdown-export) | Compatibilidad completa | Compatibilidad completa, respeta los grupos de usuarios | Compatibilidad completa, respeta los grupos de usuarios | -| [Exportación a PDF](/es/optimize/pdf-exports) | Compatibilidad completa | No compatible | No compatible | -| [Búsqueda](/es/ai/assistant) | Compatibilidad completa | Compatibilidad completa, respeta los grupos de usuarios | Compatibilidad completa, respeta los grupos de usuarios | -| [Assistant](/es/ai/assistant) | Compatibilidad completa | Compatibilidad completa, respeta los grupos de usuarios | Compatibilidad completa, respeta los grupos de usuarios | -| [skill.md](/es/ai/skillmd) | Compatibilidad completa | No compatible | No compatible | -| [Mapa del sitio](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación, pero excluye las páginas en groups | Disponible tras autenticación, pero excluye las páginas en groups | -| [robots.txt](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación | Disponible tras autenticación | \ No newline at end of file +Algunas funcionalidades se comportan de forma distinta o no están disponibles cuando habilitas la autenticación. + +| Funcionalidad | Público | Autenticación completa (todas las páginas protegidas) | Autenticación parcial (algunas páginas públicas) | +| :----------------------------------------------------------- | :------------------- | :----------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------- | +| [llms.txt y llms-full.txt](/es/ai/llmstxt) | Compatibilidad total | Disponibles con autenticación, por lo que es posible que las herramientas de IA no puedan acceder a estos archivos | Disponibles con autenticación, por lo que es posible que las herramientas de IA no puedan acceder a estos archivos | +| [servidor MCP](/es/ai/model-context-protocol) | Compatibilidad total | Requiere autenticación para conectarse | Disponible sin autenticación para las páginas públicas y con autenticación para las páginas protegidas | +| [Exportación en Markdown](/es/ai/markdown-export) | Compatibilidad total | Compatibilidad total, respeta los grupos de usuarios | Compatibilidad total, respeta los grupos de usuarios | +| [Exportación a PDF](/es/optimize/pdf-exports) | Compatibilidad total | No compatible | No compatible | +| [Búsqueda](/es/ai/assistant) | Compatibilidad total | Compatibilidad total, respeta los grupos de usuarios | Compatibilidad total, respeta los grupos de usuarios | +| [Assistant](/es/ai/assistant) | Compatibilidad total | Compatibilidad total, respeta los grupos de usuarios | Compatibilidad total, respeta los grupos de usuarios | +| [skill.md](/es/ai/skillmd) | Compatibilidad total | No compatible | No compatible | +| [Mapa del sitio](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad total | Disponible con autenticación, pero excluye las páginas de los grupos | Disponible con autenticación, pero excluye las páginas de los grupos | +| [robots.txt](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad total | Disponible con autenticación | Disponible con autenticación | \ No newline at end of file diff --git a/es/guides/maintenance.mdx b/es/guides/maintenance.mdx index 1f501c40e..eb32afd52 100644 --- a/es/guides/maintenance.mdx +++ b/es/guides/maintenance.mdx @@ -14,9 +14,13 @@ keywords: ["maintenance", "content lifecycle", "stale content"] Introduce automatizaciones cuando sea posible, como: -* **Detecta contenido obsoleto:** Ejecuta un script para señalar la documentación importante que no se haya actualizado en los últimos tres meses. ¿Sigue siendo precisa? +* **Haz seguimiento del contenido obsoleto:** Ejecuta un script para marcar con una **opción** la documentación importante que no se haya actualizado en los últimos tres meses. ¿Sigue siendo precisa? * **Automatiza las actualizaciones de la documentación:** Crea un flujo de trabajo para actualizar automáticamente la documentación cuando se fusione código con la [API del agente](/es/guides/automate-agent). -* **Aplica estándares con linters:** Usa [Vale](http://Vale.sh) o [verificaciones de CI](/es/deploy/ci) para detectar automáticamente problemas de formato, desviaciones de estilo de redacción o metadata faltante en cada solicitud de extracción. +* **Aplica estándares con linters:** Usa [Vale](http://Vale.sh) o [verificaciones de CI](/es/deploy/ci) para detectar automáticamente problemas de formato, desviaciones del estilo de redacción o metadatos faltantes en cada solicitud de extracción. + + + Usa [workflows](/es/agent/workflows) para automatizar tareas de mantenimiento recurrentes, como aplicar guías de estilo, verificar metadatos o redactar registros de cambios. +
## Configura un proceso de revisión diff --git a/es/guides/seo.mdx b/es/guides/seo.mdx index 7ea89555c..aac3f7d42 100644 --- a/es/guides/seo.mdx +++ b/es/guides/seo.mdx @@ -5,7 +5,7 @@ keywords: ["search engine optimization", "meta tags", "keyword research"] --- -Esta página explica estrategias fundamentales para optimizar el SEO de tu documentación. + Esta página explica estrategias fundamentales para optimizar el SEO de tu documentación.
@@ -22,13 +22,17 @@ Facilita que los motores de búsqueda exploren tu redacción y estructura. ## Conceptos básicos de SEO técnico
-Una vez que tu contenido esté optimizado, asegúrate de que tu documentación rinda bien desde el punto de vista técnico. +Una vez que tu contenido esté optimizado, asegúrate de que tu documentación funcione bien desde el punto de vista técnico. -Estas prácticas básicas de SEO técnico ayudan a que tu documentación sea más fácil de encontrar: +Estas prácticas básicas de SEO técnico ayudan a que tu documentación sea más fácil de descubrir: -* **Metatags y descripciones:** Redacta títulos optimizados para SEO (50–60 caracteres) y descripciones (150–160 caracteres) para cada página. La mayoría de los [metatags](/es/optimize/seo) se generan automáticamente. -* **Texto alternativo para imágenes:** Incluye texto alternativo descriptivo en las imágenes con palabras clave relevantes. Por ejemplo, “flujo de autenticación de API con OAuth 2.0” en lugar de solo “diagrama”. Esto mejora el SEO y la accesibilidad. -* **Sitemaps:** Asegúrate de que tu sitemap esté actualizado. Mintlify genera automáticamente un sitemap. No obstante, puedes crear uno manualmente si prefieres un formato personalizado. Una vez creado, los motores de búsqueda lo indexan con el tiempo, pero puedes enviar tu sitemap directamente a Google Search Console para acelerar el proceso. +* **Meta tags y descripciones:** Redacta títulos optimizados para SEO (50-60 caracteres) y descripciones (150-160 caracteres) para cada página. La mayoría de los [meta tags](/es/optimize/seo) se generan automáticamente. +* **Texto alternativo para imágenes:** Proporciona texto alternativo descriptivo para las imágenes con palabras clave relevantes. Por ejemplo, "flujo de autenticación de API con OAuth 2.0" en lugar de solo "diagrama". Esto mejora el SEO y la accesibilidad. +* **Sitemaps:** Asegúrate de que tu sitemap esté actualizado. Mintlify genera automáticamente un sitemap. Sin embargo, puedes crear un sitemap manualmente si prefieres un formato personalizado. Una vez creado, los motores de búsqueda indexan los mapas del sitio con el tiempo, pero puedes enviar tu sitemap directamente a Google Search Console para acelerar el proceso. + + + Usa un [flujo de trabajo](/es/agent/workflows) para ejecutar una auditoría semanal de SEO que verifique metadatos faltantes o deficientes y abra una solicitud de extracción con mejoras. +
## Rendimiento de la página diff --git a/es/guides/style-and-tone.mdx b/es/guides/style-and-tone.mdx index 3cbba72d9..b797865a2 100644 --- a/es/guides/style-and-tone.mdx +++ b/es/guides/style-and-tone.mdx @@ -22,13 +22,13 @@ keywords: ["principios de redacción", "voz activa", "redacción técnica", "gu ## Errores comunes de redacción
-- **Errores ortográficos y gramaticales.** Incluso unos pocos errores ortográficos y gramaticales en tu documentación la hacen menos creíble y más difícil de leer. -- **Terminología inconsistente.** Llamar algo “API key” en un párrafo y luego “token de API” en el siguiente dificulta que los usuarios puedan seguir la explicación. -- **Terminología centrada en el producto.** Tus usuarios no tienen todo el contexto de tu producto. Usa un lenguaje con el que tus usuarios estén familiarizados. -- **Expresiones coloquiales.** Especialmente en localización, las expresiones coloquiales perjudican la claridad. +* **Errores ortográficos y gramaticales.** Incluso unos pocos errores ortográficos y gramaticales en tu documentación la hacen menos creíble y más difícil de leer. +* **Terminología inconsistente.** Llamar algo “API key” en un párrafo y luego “token de API” en el siguiente dificulta que los usuarios puedan seguir la explicación. +* **Terminología centrada en el producto.** Tus usuarios no tienen todo el contexto de tu producto. Usa un lenguaje con el que tus usuarios estén familiarizados. +* **Expresiones coloquiales.** Especialmente en localización, las expresiones coloquiales perjudican la claridad.
- ## Consejos para aplicar el estilo + ## Sugerencias para aplicar el estilo
Aprovecha guías de estilo existentes para estandarizar tu documentación: @@ -39,6 +39,10 @@ Aprovecha guías de estilo existentes para estandarizar tu documentación: Cuando tengas claros los principios de redacción que quieres implementar, automatiza todo lo que puedas. Puedes usar [verificaciones de CI](/es/deploy/ci) o linters como [Vale](https://vale.sh). + + Usa un [workflow](/es/agent/workflows) para ejecutar una auditoría de estilo de forma programada o cada vez que se envíen cambios a tu repositorio de documentación, a fin de corregir automáticamente las infracciones y señalar cualquier aspecto que requiera una revisión adicional. + + diff --git a/fr/api-playground/overview.mdx b/fr/api-playground/overview.mdx index fbb23abd0..61a17854c 100644 --- a/fr/api-playground/overview.mdx +++ b/fr/api-playground/overview.mdx @@ -96,7 +96,9 @@ Personnalisez votre bac à sable d’API en définissant les propriétés suivan - Indique s’il faut faire passer les requêtes API via un serveur proxy. Valeur par défaut : `true`. + Indique s’il faut faire passer les requêtes API via le serveur proxy de Mintlify. Valeur par défaut : `true`. + + Lorsque `true`, les requêtes du bac à sable sont acheminées via les serveurs de Mintlify. Lorsque `false`, le bac à sable envoie les requêtes directement du navigateur vers votre API. Définissez cette valeur sur `false` lorsque votre API accepte les requêtes directes du navigateur et que vous n’avez pas besoin que Mintlify relaie le trafic. Par exemple, lorsque votre API nécessite des en-têtes spécifiques qui ne peuvent pas être transmis via le proxy ou lorsque vous avez besoin que la requête provienne directement du navigateur de l’utilisateur à des fins d’authentification. @@ -224,6 +226,17 @@ L’extension `x-mint` est recommandée afin que toute votre documentation d’A Les pages MDX individuelles sont recommandées pour les petites API ou lorsque vous souhaitez expérimenter des modifications page par page. +
+ ## Rendu des réponses +
+ +Le playground affiche automatiquement les réponses en fonction de l’en-tête `Content-Type` renvoyé par votre API. + +* **Images** : affichées directement dans la page (`image/*`). +* **Audio** : affiché avec un lecteur audio intégré (`audio/*`). +* **Vidéo** : affichée avec un lecteur vidéo intégré (`video/*`). Toute réponse avec un type de contenu `video/*`, comme `video/mp4` ou `video/webm`, s’affiche directement dans le playground sous forme de vidéo lisible. +* **Toutes les autres réponses** : affichées dans un code block. +
## Pour aller plus loin
diff --git a/fr/deploy/authentication-setup.mdx b/fr/deploy/authentication-setup.mdx index 8f62fc70b..1a011e1d8 100644 --- a/fr/deploy/authentication-setup.mdx +++ b/fr/deploy/authentication-setup.mdx @@ -11,12 +11,12 @@ keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password'] - L'authentification n'est disponible que pour la documentation hébergée sur un domaine personnalisé ou un sous-domaine Mintlify (par exemple, `docs.exemple.com` ou `exemple.mintlify.dev`). L'authentification **n'est pas prise en charge** lors de l'utilisation d'un [chemin de base personnalisé](/fr/deploy/docs-subpath) (par exemple, `exemple.com/docs`). + L'authentification n'est disponible que pour la documentation hébergée sur un domaine personnalisé ou un sous-domaine Mintlify (par exemple, `docs.example.com` ou `example.mintlify.dev`). L'authentification **n'est pas prise en charge** lors de l'utilisation d'un [chemin de base personnalisé](/fr/deploy/docs-subpath) (par exemple, `example.com/docs`). L’authentification exige que les utilisateurs se connectent avant d’accéder à votre documentation. -Lorsque vous activez l’authentification, les utilisateurs doivent se connecter pour accéder à l’ensemble du contenu. Vous pouvez définir certaines pages ou certains groupes comme publics tout en gardant les autres pages protégées. +Lorsque vous activez l’authentification, les utilisateurs doivent se connecter pour accéder à tout le contenu. Vous pouvez configurer des pages ou des groupes spécifiques comme publics tout en gardant les autres pages protégées.
## Configurer l’authentification @@ -494,14 +494,14 @@ Lorsque vous utilisez l’authentification OAuth ou JWT, votre système renvoie Certaines fonctionnalités se comportent différemment ou ne sont pas disponibles lorsque vous activez l’authentification. -| Fonctionnalité | Public | Entièrement authentifié (toutes les pages protégées) | Partiellement authentifié (certaines pages publiques) | -| :------------------------------------------------------- | :----------------------- | :--------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------- | -| [llms.txt and llms-full.txt](/fr/ai/llmstxt) | Prise en charge complète | Disponible derrière l’authentification, les outils d’IA peuvent donc ne pas avoir accès aux fichiers | Disponible derrière l’authentification, les outils d’IA peuvent donc ne pas avoir accès aux fichiers | -| [MCP server](/fr/ai/model-context-protocol) | Prise en charge complète | Nécessite une authentification pour se connecter | Disponible sans authentification pour les pages publiques et avec authentification pour les pages protégées | -| [Markdown export](/fr/ai/markdown-export) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs | -| [Export PDF](/fr/optimize/pdf-exports) | Prise en charge complète | Non pris en charge | Non pris en charge | -| [Search](/fr/ai/assistant) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs | -| [Assistant](/fr/ai/assistant) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs | -| [skill.md](/fr/ai/skillmd) | Prise en charge complète | Non pris en charge | Non pris en charge | -| [Sitemap](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Disponible derrière l’authentification, mais exclut les pages dans des groupes | Disponible derrière l’authentification, mais exclut les pages dans des groupes | -| [robots.txt](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Disponible derrière l’authentification | Disponible derrière l’authentification | \ No newline at end of file +| Fonctionnalité | Public | Entièrement authentifié (toutes les pages protégées) | Partiellement authentifié (certaines pages publiques) | +| :--------------------------------------------------------- | :----------------------- | :--------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------- | +| [llms.txt et llms-full.txt](/fr/ai/llmstxt) | Prise en charge complète | Accessible après authentification ; les outils d’IA peuvent donc ne pas pouvoir accéder aux fichiers | Accessible après authentification ; les outils d’IA peuvent donc ne pas pouvoir accéder aux fichiers | +| [serveur MCP](/fr/ai/model-context-protocol) | Prise en charge complète | Nécessite une authentification pour se connecter | Disponible sans authentification pour les pages publiques et avec authentification pour les pages protégées | +| [Export Markdown](/fr/ai/markdown-export) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs | +| [Export PDF](/fr/optimize/pdf-exports) | Prise en charge complète | Non pris en charge | Non pris en charge | +| [Recherche](/fr/ai/assistant) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs | +| [Assistant](/fr/ai/assistant) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs | +| [skill.md](/fr/ai/skillmd) | Prise en charge complète | Non pris en charge | Non pris en charge | +| [Plan du site](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Accessible après authentification, mais exclut les pages appartenant à des groupes | Accessible après authentification, mais exclut les pages appartenant à des groupes | +| [robots.txt](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Accessible après authentification | Accessible après authentification | \ No newline at end of file diff --git a/fr/guides/maintenance.mdx b/fr/guides/maintenance.mdx index a1f5d2522..b506e7ba6 100644 --- a/fr/guides/maintenance.mdx +++ b/fr/guides/maintenance.mdx @@ -14,9 +14,13 @@ keywords: ["maintenance", "content lifecycle", "stale content"] Introduisez des automatisations lorsque c’est possible, par exemple : -* **Suivez le contenu obsolète :** Exécutez un script pour signaler les documents importants qui n’ont pas été mis à jour au cours des trois derniers mois. Sont-ils toujours à jour ? -* **Automatisez les mises à jour de la documentation :** Mettez en place un workflow pour actualiser automatiquement la documentation lorsque du code est fusionné avec l’[agent API](/fr/guides/automate-agent). -* **Faites respecter les normes avec des linters :** Utilisez [Vale](http://Vale.sh) ou des [vérifications CI](/fr/deploy/ci) pour détecter automatiquement les problèmes de formatage, les écarts de style rédactionnel ou les metadata manquantes dans chaque pull request (demande de fusion). +* **Suivez le contenu obsolète :** Exécutez un script pour signaler les documents importants qui n’ont pas été mis à jour au cours des trois derniers mois. Sont-ils toujours précis ? +* **Automatisez les mises à jour de la documentation :** Mettez en place un workflow pour mettre automatiquement à jour la documentation lorsque du code est fusionné avec l’[agent API](/fr/guides/automate-agent). +* **Faites respecter les normes avec des linters :** Utilisez [Vale](http://Vale.sh) ou des [vérifications CI](/fr/deploy/ci) pour détecter automatiquement les problèmes de formatage, les écarts de style rédactionnel ou l’absence de métadonnées dans chaque pull request. + + + Utilisez des [workflows](/fr/agent/workflows) pour automatiser les tâches de maintenance récurrentes, comme l’application des guides de style, la vérification des métadonnées ou la rédaction des journaux des modifications. +
## Mettre en place un processus de relecture diff --git a/fr/guides/seo.mdx b/fr/guides/seo.mdx index 554b4b2ae..320f4e984 100644 --- a/fr/guides/seo.mdx +++ b/fr/guides/seo.mdx @@ -5,7 +5,7 @@ keywords: ["search engine optimization", "meta tags", "keyword research"] --- -Cette page explique des stratégies essentielles pour optimiser le SEO de votre documentation. + Cette page explique des stratégies essentielles pour optimiser le SEO de votre documentation.
@@ -30,6 +30,10 @@ Ces pratiques fondamentales en SEO technique rendent votre documentation plus fa * **Texte alternatif pour les images :** Fournissez un texte alternatif descriptif pour les images, intégrant des mots-clés pertinents. Par exemple, « Flux d’authentification OAuth 2.0 d’une API » plutôt que simplement « diagramme ». Cela améliore le SEO et l’accessibilité. * **Sitemaps :** Assurez-vous que votre sitemap est à jour. Mintlify génère automatiquement un sitemap. Vous pouvez toutefois créer manuellement un sitemap si vous préférez un format personnalisé. Une fois créé, les moteurs de recherche l’indexent au fil du temps, mais vous pouvez soumettre votre sitemap directement dans la Google Search Console pour accélérer le processus. + + Utilisez un [workflow](/fr/agent/workflows) pour exécuter un audit SEO hebdomadaire qui vérifie les metadata manquantes ou de faible qualité et ouvre une pull request (demande de fusion) avec des améliorations. + +
## Performance des pages
diff --git a/fr/guides/style-and-tone.mdx b/fr/guides/style-and-tone.mdx index 17c4eeed7..567d460d6 100644 --- a/fr/guides/style-and-tone.mdx +++ b/fr/guides/style-and-tone.mdx @@ -22,10 +22,10 @@ keywords: ["writing principles", "active voice", "technical writing", "style gui ## Erreurs de rédaction courantes
-- **Fautes d'orthographe et de grammaire.** Même quelques fautes d'orthographe et de grammaire dans votre documentation la rendent moins crédible et plus difficile à lire. -- **Terminologie incohérente.** Parler d'une « API key » dans un paragraphe puis d'un « API token » dans le suivant rend le suivi difficile pour les utilisateurs. -- **Terminologie centrée sur le produit.** Vos utilisateurs n'ont pas l'ensemble du contexte de votre produit. Utilisez un langage familier pour vos utilisateurs. -- **Expressions familières.** En particulier pour la localisation, les expressions familières nuisent à la clarté. +* **Fautes d'orthographe et de grammaire.** Même quelques fautes d'orthographe et de grammaire dans votre documentation la rendent moins crédible et plus difficile à lire. +* **Terminologie incohérente.** Parler d'une « API key » dans un paragraphe puis d'un « API token » dans le suivant rend le suivi difficile pour les utilisateurs. +* **Terminologie centrée sur le produit.** Vos utilisateurs n'ont pas l'ensemble du contexte de votre produit. Utilisez un langage familier pour vos utilisateurs. +* **Expressions familières.** En particulier pour la localisation, les expressions familières nuisent à la clarté.
## Conseils pour appliquer un style cohérent @@ -37,7 +37,11 @@ Appuyez-vous sur des guides de style existants pour standardiser votre documenta * [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse) * [Google Developer Documentation Style Guide](https://developers.google.com/style) -Une fois les principes rédactionnels à adopter définis, automatisez au maximum. Vous pouvez utiliser des [contrôles CI](/fr/deploy/ci) ou des analyseurs comme [Vale](https://vale.sh). +Lorsque vous savez quels principes de rédaction vous souhaitez mettre en œuvre, automatisez autant que possible. Vous pouvez utiliser des [contrôles CI](/fr/deploy/ci) ou des analyseurs comme [Vale](https://vale.sh). + + + Utilisez un [workflow](/fr/agent/workflows) pour exécuter un audit de style selon une planification ou chaque fois que des modifications sont envoyées vers votre référentiel de documentation, afin de corriger automatiquement les violations et de signaler tout élément nécessitant un examen plus approfondi. + -启用认证后，部分功能的行为会有所不同，或可能不可用。 - -| 功能 | 公开 | 完全认证 (所有页面受保护) | 部分认证 (部分页面公开) | -| :------------------------------------------------------- | :--- | :----------------------------- | :----------------------------- | -| [llms.txt 和 llms-full.txt](/zh/ai/llmstxt) | 完全支持 | 需要通过认证后才能访问，因此 AI 工具可能无法访问这些文件 | 需要通过认证后才能访问，因此 AI 工具可能无法访问这些文件 | -| [MCP 服务器](/zh/ai/model-context-protocol) | 完全支持 | 连接时需要认证 | 公开页面无需认证即可使用，受保护页面则需要认证 | -| [Markdown 导出](/zh/ai/markdown-export) | 完全支持 | 完全支持，尊重用户分组 | 完全支持，尊重用户分组 | -| [PDF 导出](/zh/optimize/pdf-exports) | 完全支持 | 不支持 | 不支持 | -| [搜索](/zh/ai/assistant) | 完全支持 | 完全支持，尊重用户分组 | 完全支持，尊重用户分组 | -| [AI 助手](/zh/ai/assistant) | 完全支持 | 完全支持，尊重用户分组 | 完全支持，尊重用户分组 | -| [skill.md](/zh/ai/skillmd) | 完全支持 | 不支持 | 不支持 | -| [站点地图](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 需要通过认证后才能访问，但会排除 groups 中的页面 | 需要通过认证后才能访问，但会排除 groups 中的页面 | -| [robots.txt](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 需要通过认证后才能访问 | 需要通过认证后才能访问 | \ No newline at end of file +启用认证后，某些功能的行为会有所不同，或无法使用。 + +| 功能 | 公开 | 完全认证 (所有页面受保护) | 部分认证 (某些页面公开) | +| :------------------------------------------------------- | :--- | :------------------------- | :------------------------- | +| [llms.txt and llms-full.txt](/zh/ai/llmstxt) | 完全支持 | 可在认证后访问，因此 AI 工具可能无法访问这些文件 | 可在认证后访问，因此 AI 工具可能无法访问这些文件 | +| [MCP 服务器](/zh/ai/model-context-protocol) | 完全支持 | 连接时需要认证 | 公开页面无需认证即可访问，受保护页面则需要认证 | +| [Markdown 导出](/zh/ai/markdown-export) | 完全支持 | 完全支持，并遵循用户组设置 | 完全支持，并遵循用户组设置 | +| [PDF 导出](/zh/optimize/pdf-exports) | 完全支持 | 不支持 | 不支持 | +| [搜索](/zh/ai/assistant) | 完全支持 | 完全支持，并遵循用户组设置 | 完全支持，并遵循用户组设置 | +| [AI 助手](/zh/ai/assistant) | 完全支持 | 完全支持，并遵循用户组设置 | 完全支持，并遵循用户组设置 | +| [skill.md](/zh/ai/skillmd) | 完全支持 | 不支持 | 不支持 | +| [网站地图](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 可在认证后访问，但不包含 groups 中的页面 | 可在认证后访问，但不包含 groups 中的页面 | +| [robots.txt](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 可在认证后访问 | 可在认证后访问 | \ No newline at end of file diff --git a/zh/guides/maintenance.mdx b/zh/guides/maintenance.mdx index c466d7a36..253b309a0 100644 --- a/zh/guides/maintenance.mdx +++ b/zh/guides/maintenance.mdx @@ -14,9 +14,13 @@ keywords: ["maintenance", "content lifecycle", "stale content"] 在可行的地方引入自动化，例如： -* **跟踪过时内容：** 运行脚本标记过去三个月未更新的重要文档。它们是否仍然准确？ -* **自动更新文档：** 构建工作流，当代码合并时，通过 [agent API](/zh/guides/automate-agent) 自动更新文档。 -* **用 linter 强制执行标准：** 使用 [Vale](http://Vale.sh) 或 [CI 检查](/zh/deploy/ci)，在每个拉取请求（PR；亦称“合并请求”/Merge Request）中自动捕获格式问题、写作风格偏差或缺失的 metadata。 +* **跟踪过时内容：** 运行脚本，标记过去三个月未更新的重要文档。它们是否仍然准确？ +* **自动更新文档：** 构建工作流，在代码合并时通过 [agent API](/zh/guides/automate-agent) 自动更新文档。 +* **用 lint 工具强制执行标准：** 使用 [Vale](http://Vale.sh) 或 [CI checks](/zh/deploy/ci)，在每个拉取请求中自动发现格式问题、写作风格偏差或缺失的元数据。 + + + 使用 [工作流](/zh/agent/workflows) 自动执行重复性的维护任务，例如强制遵循风格指南、检查元数据或起草更新日志。 +
## 建立评审流程 @@ -27,7 +31,7 @@ keywords: ["maintenance", "content lifecycle", "stale content"] 在效率与质量之间取得平衡： * **聚焦高影响力文档。** 并非每个页面都需要定期更新。务必定期审查最重要的页面，确保其准确且具备时效性。 -* **善用社区力量。** 如果你的文档是开源的，赋予用户通过拉取请求（PR；亦称“合并请求”/Merge Request）标记问题或提交修复的能力。这有助于建立信任并保持内容新鲜。 +* **善用社区力量。** 如果你的文档是开源的，赋予用户通过拉取请求 (PR；亦称“合并请求”/Merge Request) 标记问题或提交修复的能力。这有助于建立信任并保持内容新鲜。
## 何时该重写 diff --git a/zh/guides/seo.mdx b/zh/guides/seo.mdx index 6b1384d62..2ac852619 100644 --- a/zh/guides/seo.mdx +++ b/zh/guides/seo.mdx @@ -1,11 +1,11 @@ --- title: "SEO（搜索引擎优化）" -description: "优化 SEO，提升文档的可发现性。" +description: "改进 SEO（搜索引擎优化），提高文档的可发现性。" keywords: ["search engine optimization", "meta tags", "keyword research"] --- -本页介绍优化文档 SEO 的基础策略。 + 本页介绍优化文档 SEO (搜索引擎优化) 的基本策略。
@@ -19,27 +19,31 @@ keywords: ["search engine optimization", "meta tags", "keyword research"] * **内部链接：** 使用具描述性的锚文本链接到相关内容。例如，使用“了解更多关于速率限制”的表述，而不是“点击这里”。
- ## 技术 SEO 基础 + ## 技术 SEO (搜索引擎优化) 基础
-在优化好内容后，也要确保文档在技术层面表现良好。 +内容优化完成后，还要确保你的文档在技术层面表现良好。 -这些基础的技术 SEO（搜索引擎优化）做法有助于提升文档的可发现性： +这些基础的技术 SEO (搜索引擎优化) 实践有助于让你的文档更容易被发现： -* **Meta 标签与描述：** 为每个页面撰写有利于 SEO 的标题（50–60 个字符）和描述（150–160 个字符）。大多数[meta 标签](/zh/optimize/seo)会自动生成。 -* **图片 Alt 文本：** 为图片提供包含相关关键词的描述性 alt 文本。例如，用 “OAuth 2.0 API 认证流程” 而不是仅写 “diagram”。这有助于提升 SEO 和可访问性。 -* **站点地图（Sitemaps）：** 确保站点地图为最新。Mintlify 会自动生成站点地图；如需自定义格式，也可手动创建。创建后，搜索引擎会随着时间索引站点地图，但你也可以将其直接提交到 Google Search Console 以加快收录。 +* **Meta 标签和描述：** 为每个页面编写有利于 SEO (搜索引擎优化) 的标题 (50-60 个字符) 和描述 (150-160 个字符) 。大多数 [meta tags](/zh/optimize/seo) 都会自动生成。 +* **图片的 Alt 文本：** 为图片提供包含相关关键词的描述性 alt 文本。例如，使用“OAuth 2.0 API 身份验证流程”，而不只是“diagram”。这可以提升 SEO (搜索引擎优化) 和无障碍访问体验。 +* **站点地图：** 确保你的站点地图保持最新。Mintlify 会自动生成站点地图。不过，如果你更喜欢自定义格式，也可以手动创建站点地图。创建后，搜索引擎会随着时间推移为站点地图建立索引，但你也可以将站点地图直接提交到 Google Search Console 以加快这一过程。 + + + 使用一个[工作流](/zh/agent/workflows)每周运行一次 SEO (搜索引擎优化) 审核，检查缺失或较弱的元数据，并创建一个包含改进内容的拉取请求。 +
## 页面性能
-使用 [Google PageSpeed Insights](https://pagespeed.web.dev) 等工具识别可改进的技术层面 SEO（搜索引擎优化）机会。 +使用 [Google PageSpeed Insights](https://pagespeed.web.dev) 等工具识别可改进的技术层面 SEO (搜索引擎优化) 机会。 更高级的优化示例： -* **为速度优化媒体：** 使用 WebP 或 AVIF 等格式压缩图片，并确保页面加载迅速（理想情况下不超过 3 秒）。 -* **结构化数据（schema 标注）：** 在页面中添加 schema 标注（如 HowTo、FAQ），帮助搜索引擎更好地理解并提升内容的排名。 +* **为速度优化媒体：** 使用 WebP 或 AVIF 等格式压缩图片，并确保页面加载迅速 (理想情况下不超过 3 秒) 。 +* **结构化数据 (schema 标注) ：** 在页面中添加 schema 标注 (如 HowTo、FAQ) ，帮助搜索引擎更好地理解并提升内容的排名。
## 关键词研究 diff --git a/zh/guides/style-and-tone.mdx b/zh/guides/style-and-tone.mdx index 9b6343ce0..3b8fccbd8 100644 --- a/zh/guides/style-and-tone.mdx +++ b/zh/guides/style-and-tone.mdx @@ -22,22 +22,26 @@ keywords: ["写作原则", "主动语态", "技术写作", "风格指南"] ## 常见写作错误
-- **拼写和语法错误。** 即便只有少量拼写和语法错误，也会削弱文档的可信度，并降低可读性。 -- **术语不一致。** 在一段中将某个概念称为 “API key”，下一段又叫它 “API token”，会让用户难以理解和跟上内容。 -- **过于以产品为中心的术语。** 你的用户并不具备对你产品的完整上下文。应使用用户更熟悉的语言。 -- **口语化表达。** 尤其在本地化场景下，口语化表达会降低内容的清晰度。 +* **拼写和语法错误。** 即便只有少量拼写和语法错误，也会削弱文档的可信度，并降低可读性。 +* **术语不一致。** 在一段中将某个概念称为 “API key”，下一段又叫它 “API token”，会让用户难以理解和跟上内容。 +* **过于以产品为中心的术语。** 你的用户并不具备对你产品的完整上下文。应使用用户更熟悉的语言。 +* **口语化表达。** 尤其在本地化场景下，口语化表达会降低内容的清晰度。
- ## 执行风格的实用建议 + ## 强制执行风格的技巧
-利用现有风格指南来规范你的文档： +利用现有的风格指南来规范你的文档： * [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) * [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse) * [Google Developer Documentation Style Guide](https://developers.google.com/style) -当你明确要采纳哪些写作原则后，尽可能将其自动化。你可以使用 [CI checks](/zh/deploy/ci) 或像 [Vale](https://vale.sh) 这样的 linter。 +当你知道自己想要实施哪些写作原则时，尽可能将其自动化。你可以使用 [CI checks](/zh/deploy/ci) 或像 [Vale](https://vale.sh) 这样的 linter。 + + + 使用[工作流](/zh/agent/workflows)按计划运行风格审核，或在更改推送到你的文档仓库时运行，以自动修复违规项并标记任何需要进一步审查的内容。 +