Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions ai/skillmd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,17 @@ Group-gated skills are:

Skills without a `groups` field remain visible to everyone.

### Validate a custom skill file

Before deploying, verify that your custom skill files are valid:

- **Check the frontmatter.** Every custom skill file must start with YAML frontmatter that includes at least a `name` and a `description`. See [Frontmatter fields](#frontmatter-fields) for the full list of supported fields.
- **Preview locally.** Run [`mint dev`](/organize/settings) to serve your site locally, then open `http://localhost:3000/skill.md` to check that your custom file loads instead of the generated one.
- **Verify after deploying.** After your site deploys, append `/skill.md` to your site's URL to view the served skill file. For multiple skills, fetch `/.well-known/agent-skills/index.json` to confirm each custom skill appears in the discovery manifest.
- **Validate against the specification.** Compare your file against the [agentskills.io specification](https://agentskills.io/specification) to confirm required sections are present and formatted correctly.

Changes to custom skill files publish with your next deployment. Because generated skills can take up to 24 hours to update, custom skills are the fastest way to control what agents see.

## Skills discovery endpoints

Mintlify hosts skills directories at `/.well-known/skills/` and `/.well-known/agent-skills/` that agents can use to discover and fetch your skill files programmatically.
Expand Down
16 changes: 16 additions & 0 deletions api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,22 @@

Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`. See the [settings documentation](/organize/settings-api) for details. When using this configuration, you must configure CORS on your server since requests come directly from users' browsers rather than through your proxy.
</Accordion>
<Accordion title="API Playground requests fail with a CORS error">
A CORS error occurs when your browser blocks a cross-origin request because the response is missing the required headers. You can identify a CORS error in your browser's developer console: look for messages like `Access-Control-Allow-Origin` missing or `blocked by CORS policy`.

Check warning on line 81 in api-playground/troubleshooting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/troubleshooting.mdx#L81

Spell out 'CORS', if it's unfamiliar to the audience.

CORS errors only affect requests that go directly from the user's browser to your API. By default, Mintlify proxies API Playground requests through `/_mintlify/api/request`, so most sites don't encounter CORS issues. You typically see CORS errors when:

- You've set `api.playground.proxy` to `false` in your `docs.json`, so requests bypass the Mintlify proxy.
- You've configured a custom `api.playground.proxy` URL that points directly to your backend.

To fix CORS errors, configure your API server to return the following response headers for requests from your docs site's origin:

- `Access-Control-Allow-Origin`: Your docs site's origin (for example, `https://docs.your-site.com`) or `*` for public APIs.
- `Access-Control-Allow-Methods`: The HTTP methods your API supports (for example, `GET, POST, PUT, DELETE, OPTIONS`).
- `Access-Control-Allow-Headers`: The headers your requests send (for example, `Content-Type, Authorization`).

Your server must also handle `OPTIONS` preflight requests. If you can't modify your API server, remove the `api.playground.proxy` setting so requests route through the Mintlify proxy again.
</Accordion>
<Accordion title="OpenAPI navigation entries are not generating pages">
If you are using an OpenAPI navigation configuration, but the pages aren't generating, check these common issues:

Expand Down
10 changes: 10 additions & 0 deletions editor/drafts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,16 @@ When your draft is ready, open the publish menu to review your changes and publi
</Step>
</Steps>

## Preview a draft

Because each draft has its own branch, it also has a [preview deployment](/editor/branching-and-publishing#preview-your-changes) that reflects the current state of the draft. Share the preview URL with reviewers to show unpublished changes before you publish.

1. Open the draft you want to preview.
2. Click **Publish** in the editor toolbar to open the publish menu.
3. Copy the preview URL and send it to your reviewers.

The preview updates automatically each time the editor saves your changes. Preview URLs are publicly accessible by default. To restrict access to members of your Mintlify organization, enable preview authentication in the [Add-ons](https://app.mintlify.com/products/addons) page of your dashboard.

## Rename a draft

1. Click the <Icon icon="globe" /> deployment selector in the editor toolbar.
Expand Down
13 changes: 13 additions & 0 deletions es/ai/skillmd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,19 @@ Las skills restringidas por grupos:

Las skills sin el campo `groups` permanecen visibles para todos.

<div id="validate-a-custom-skill-file">
### Validar un archivo de skill personalizado
</div>

Antes de desplegar, verifica que tus archivos de skill personalizados sean válidos:

- **Comprueba el frontmatter.** Cada archivo de skill personalizado debe comenzar con frontmatter YAML que incluya al menos un `name` y una `description`. Consulta [Campos de frontmatter](#frontmatter-fields) para ver la lista completa de campos admitidos.
- **Previsualiza en local.** Ejecuta [`mint dev`](/es/organize/settings) para servir tu sitio localmente y abre `http://localhost:3000/skill.md` para comprobar que se carga tu archivo personalizado en lugar del generado.
- **Verifica después de desplegar.** Cuando se despliegue tu sitio, añade `/skill.md` a la URL de tu sitio para ver el archivo de skill servido. Si tienes varias skills, obtén `/.well-known/agent-skills/index.json` para confirmar que cada skill personalizada aparece en el manifiesto de descubrimiento.
- **Valida contra la especificación.** Compara tu archivo con la [especificación de agentskills.io](https://agentskills.io/specification) para confirmar que las secciones obligatorias están presentes y con el formato correcto.

Los cambios en los archivos de skill personalizados se publican con tu siguiente despliegue. Como las skills generadas pueden tardar hasta 24 horas en actualizarse, las skills personalizadas son la forma más rápida de controlar lo que ven los agentes.

<div id="skills-discovery-endpoints">
## Endpoints de descubrimiento de skills
</div>
Expand Down
17 changes: 17 additions & 0 deletions es/api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,23 @@ Si sus páginas de la API no se muestran correctamente, revise estos problemas d
Como alternativa, si tu proxy inverso impide aceptar solicitudes `POST`, puedes configurar Mintlify para enviar solicitudes directamente a tu backend con el ajuste `api.playground.proxy` en el `docs.json`, como se describe en la [documentación de configuración](/es/organize/settings-api). Al usar esta configuración, deberás configurar CORS en tu servidor, ya que las solicitudes llegarán directamente desde los navegadores de los usuarios en lugar de pasar por tu proxy.
</Accordion>

<Accordion title="Las solicitudes del área de pruebas de la API fallan con un error de CORS">
Un error de CORS se produce cuando tu navegador bloquea una solicitud entre orígenes porque a la respuesta le faltan los encabezados requeridos. Puedes identificar un error de CORS en la consola de desarrollador de tu navegador: busca mensajes como que falta `Access-Control-Allow-Origin` o `blocked by CORS policy`.

Los errores de CORS solo afectan a las solicitudes que van directamente desde el navegador del usuario a tu API. De forma predeterminada, Mintlify redirige las solicitudes del área de pruebas de la API a través de `/_mintlify/api/request`, por lo que la mayoría de los sitios no se encuentran con problemas de CORS. Normalmente ves errores de CORS cuando:

- Has establecido `api.playground.proxy` en `false` en tu `docs.json`, por lo que las solicitudes omiten el proxy de Mintlify.
- Has configurado una URL personalizada en `api.playground.proxy` que apunta directamente a tu backend.

Para corregir los errores de CORS, configura tu servidor de API para que devuelva los siguientes encabezados de respuesta en las solicitudes provenientes del origen de tu sitio de documentación:

- `Access-Control-Allow-Origin`: El origen de tu sitio de documentación (por ejemplo, `https://docs.your-site.com`) o `*` para APIs públicas.
- `Access-Control-Allow-Methods`: Los métodos HTTP que admite tu API (por ejemplo, `GET, POST, PUT, DELETE, OPTIONS`).
- `Access-Control-Allow-Headers`: Los encabezados que envían tus solicitudes (por ejemplo, `Content-Type, Authorization`).

Tu servidor también debe manejar las solicitudes de preflight `OPTIONS`. Si no puedes modificar tu servidor de API, elimina el ajuste `api.playground.proxy` para que las solicitudes vuelvan a enrutarse a través del proxy de Mintlify.
</Accordion>

<Accordion title="Las entradas de navigation de OpenAPI no generan páginas">
Si usas una configuración de navigation de OpenAPI, pero las páginas no se generan, revisa estos problemas comunes:

Expand Down
12 changes: 12 additions & 0 deletions es/editor/drafts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,18 @@ Cuando tu borrador esté listo, abre el menú de publicación para revisar tus c
</Step>
</Steps>

<div id="preview-a-draft">
## Previsualizar un borrador
</div>

Como cada borrador tiene su propia branch, también tiene un [despliegue de previsualización](/es/editor/branching-and-publishing#preview-your-changes) que refleja el estado actual del borrador. Comparte la URL de previsualización con los revisores para mostrar los cambios sin publicar antes de publicarlos.

1. Abre el borrador que quieres previsualizar.
2. Haz clic en **Publish** en la barra de herramientas del editor para abrir el menú de publicación.
3. Copia la URL de previsualización y envíala a tus revisores.

La previsualización se actualiza automáticamente cada vez que el editor guarda tus cambios. Las URLs de previsualización son accesibles públicamente de forma predeterminada. Para restringir el acceso a los miembros de tu organización de Mintlify, activa la autenticación de previsualización en la página [Add-ons](https://app.mintlify.com/products/addons) de tu panel.

<div id="rename-a-draft">
## Renombrar un borrador
</div>
Expand Down
17 changes: 17 additions & 0 deletions es/integrations/analytics/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,23 @@ Configura las credenciales de tu proveedor de Analytics en el objeto `integratio
}
```

<div id="verify-your-setup">
## Verifica tu configuración
</div>

Después de desplegar el `docs.json` actualizado, comprueba que los eventos están llegando a tu proveedor de Analytics:

1. **Despliega tus cambios.** Los eventos de Analytics solo comienzan a fluir después de que los cambios en tu `docs.json` se despliegan en tu sitio en producción. Las sesiones locales de `mint dev` no envían eventos.
2. **Activa un evento.** Visita tu sitio en producción e interactúa con él. Consulta una página, realiza una búsqueda o envía una solicitud en el área de pruebas de la API para generar uno de los [eventos rastreados](#tracked-events).
3. **Consulta la vista en tiempo real de tu proveedor.** La mayoría de las plataformas muestran los eventos entrantes en menos de un minuto:
- Google Analytics 4: **Reports → Realtime**.
- PostHog: **Activity → Live events**.
- Mixpanel: **Events → Live view**.
- Amplitude: **Data → Live event stream**.
4. **Desactiva los bloqueadores de anuncios.** Extensiones del navegador como uBlock Origin y Privacy Badger bloquean muchos scripts de Analytics de forma predeterminada. Prueba en una ventana de incógnito con las extensiones desactivadas si los eventos no aparecen.

Si los eventos siguen sin llegar, verifica de nuevo que estás usando el tipo de clave correcto para cada proveedor (consulta la nota en [Configuración](#setup)) y que los cambios en tu `docs.json` se han desplegado correctamente.

<div id="tracked-events">
## Eventos rastreados
</div>
Expand Down
55 changes: 55 additions & 0 deletions es/migration-services/go-live-checklist.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: "Lista de verificación para la puesta en producción"
description: "Verifica que tu sitio de Mintlify está listo antes de ponerlo en producción."
noindex: true
---

Esta es una lista completa de configuraciones que debes establecer y ajustes que debes validar antes de la puesta en producción. Algunos pasos pueden no aplicarse a tu despliegue concreto y puedes omitirlos.

## Configuración principal

- **Conecta tu repositorio de documentación a Mintlify.** Instala la [app de GitHub](/es/deploy/github) o conecta tu [repositorio de GitLab](/es/deploy/gitlab).
- Si ya has instalado la app de GitHub, desinstálala y vuelve a instalarla. Para verificar este paso, realiza un cambio en tu documentación localmente, envíalo a GitHub y comprueba que tu sitio se vuelve a desplegar.
- Si almacenas tu documentación en más de un repositorio, configura una [estructura multi-repositorio](/es/deploy/multi-repo) para compilar tu sitio a partir de varios repositorios. Si todo tu contenido está en un único repositorio, omite este paso.
- **Invita a los miembros del equipo.** Invita a cualquier persona que necesite acceso desde la página [Members](https://app.mintlify.com/settings/organization/members) de tu panel. Consulta [Roles](/es/dashboard/roles) para obtener más información.

## Seguridad

- Revisa quién puede acceder a tu panel.
- Configura el [SSO del panel](/es/dashboard/sso) para que tu equipo acceda al panel y al editor.
- Configura las [políticas de acceso al panel](/es/dashboard/network-access).
- Configura el [aprovisionamiento SCIM](/es/dashboard/scim).
- Revisa el acceso a tu sitio de Mintlify.
- Si restringes tu sitio a determinados usuarios, configura la [autenticación](/es/deploy/authentication-setup).
- Revisa qué grupos tienen acceso a las páginas y qué páginas son públicas.

## Validación del contenido

- **Verifica tu arquitectura de la información.** ¿Es la estructura de navegación correcta? ¿Faltan secciones? Consulta los [tipos de contenido](/es/guides/content-types) como referencia.
- Si es necesario, configura [redirecciones](/es/create/redirects).

## Funciones del panel

- **Activa y configura el asistente.** Consulta [Configurar el asistente](/es/assistant/configure) y [Añadir skills al asistente](/es/assistant/skills).
- **Habilita los complementos.** Ve a la página [Add-ons](https://app.mintlify.com/settings/deployment/addons) de tu panel. Habilita los complementos relevantes, como los comentarios del agente, las [comprobaciones de CI](/es/deploy/ci), los temas relacionados y más.
- **Configura el agente de Slack.** Esto te permite hacer cambios en tu contenido directamente desde Slack. Consulta [Añadir el agente a Slack](/es/agent/slack#add-the-agent-to-slack).
- **Configura las automatizaciones.** Consulta [cómo habilitar una automatización](/es/automations/manage#enable-an-automation).
- **Instala los plugins de Analytics relevantes.** Consulta la [lista de integraciones de Analytics](/es/integrations/analytics/overview).

## Puesta en producción

- **Configura tu dominio personalizado.** Consulta la [guía de dominio personalizado](/es/customize/custom-domain).

<div id="post-launch-verification">
## Verificación posterior al lanzamiento
</div>

Después de que se propaguen los cambios de DNS y tu dominio personalizado esté activo, comprueba de forma puntual que todo funciona de principio a fin:

- **Carga las páginas clave.** Visita tu página de inicio y varias páginas de alto tráfico en el dominio personalizado para confirmar que se muestran correctamente con SSL.
- **Prueba la navegación y la búsqueda.** Haz clic en los elementos de navegación de nivel superior y realiza algunas búsquedas para confirmar que los resultados devuelven las páginas esperadas.
- **Verifica las redirecciones.** Carga una URL de tu sitio de documentación anterior (o cualquier [redirección](/es/create/redirects) que hayas configurado) y confirma que llega a la página nueva correcta.
- **Confirma el acceso autenticado.** Si tu sitio usa [autenticación](/es/deploy/authentication-setup), inicia sesión como usuario de prueba y verifica que puedes acceder a las páginas que tu grupo de usuarios tiene permitido ver.
- **Revisa Analytics.** Abre la vista en tiempo real de tu proveedor de Analytics y confirma que los eventos están fluyendo desde el dominio en producción. Consulta [Verifica tu configuración](/es/integrations/analytics/overview#verify-your-setup).
- **Ejecuta una comprobación de enlaces rotos.** Desde el directorio de tu proyecto, ejecuta `mint broken-links` para detectar cualquier enlace interno que siga apuntando al dominio antiguo o a páginas eliminadas.
- **Prueba el área de pruebas de la API.** Si tu documentación incluye una referencia de API, envía una solicitud desde el área de pruebas y confirma que llega a tu backend sin errores de CORS.
13 changes: 13 additions & 0 deletions fr/ai/skillmd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,19 @@ Les skills restreints par groupes :

Les skills sans champ `groups` restent visibles pour tous.

<div id="validate-a-custom-skill-file">
### Valider un fichier de skill personnalisé
</div>

Avant de déployer, vérifiez que vos fichiers de skill personnalisés sont valides :

- **Vérifiez le frontmatter.** Chaque fichier de skill personnalisé doit commencer par un frontmatter YAML incluant au minimum un `name` et une `description`. Consultez les [champs de frontmatter](#frontmatter-fields) pour la liste complète des champs pris en charge.
- **Prévisualisez localement.** Exécutez [`mint dev`](/fr/organize/settings) pour servir votre site en local, puis ouvrez `http://localhost:3000/skill.md` pour vérifier que votre fichier personnalisé se charge à la place du fichier généré.
- **Vérifiez après le déploiement.** Une fois votre site déployé, ajoutez `/skill.md` à l'URL de votre site pour afficher le fichier de skill servi. Pour plusieurs skills, récupérez `/.well-known/agent-skills/index.json` afin de confirmer que chaque skill personnalisé apparaît dans le manifeste de découverte.
- **Validez par rapport à la spécification.** Comparez votre fichier à la [spécification agentskills.io](https://agentskills.io/specification) pour confirmer que les sections requises sont présentes et correctement formatées.

Les modifications apportées aux fichiers de skill personnalisés sont publiées lors de votre prochain déploiement. Les skills générés pouvant mettre jusqu'à 24 heures à se mettre à jour, les skills personnalisés constituent le moyen le plus rapide de contrôler ce que les agents voient.

<div id="skills-discovery-endpoints">
## Endpoints de découverte des skills
</div>
Expand Down
Loading
Loading