Skip to content
Closed
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
5 changes: 5 additions & 0 deletions es/agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Usa el agente para:
* Actualizar documentación existente con nuevas funcionalidades o cambios en la API.
* Procesar e incluir imágenes, diagramas y otros archivos a partir de archivos adjuntos de Slack.
* Buscar y revisar ejemplos de código y referencias de API en toda tu documentación.
* Automatizar el mantenimiento de la documentación mediante flujos de trabajo.
* Responder preguntas sobre tu documentación y temas de redacción técnica.
* Atender comentarios de revisión de código para mantener la calidad de la documentación.
* Capturar conocimiento de conversaciones en Slack y solicitudes de extracción antes de que se pierda.
Expand Down Expand Up @@ -64,4 +65,8 @@ Usa el agente para:

<Card title="Escribir prompts eficaces" horizontal icon="pen" href="/es/agent/effective-prompts">
Obtén mejores resultados con prompts más específicos.
</Card>

<Card title="Automatizar con flujos de trabajo" horizontal icon="refresh-cw" href="/es/agent/workflows">
Automatiza tareas recurrentes y el mantenimiento de la documentación mediante flujos de trabajo.
</Card>
8 changes: 8 additions & 0 deletions es/agent/use-cases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,14 @@ Proporciona al agente los comentarios de tus usuarios para realizar actualizacio

Por ejemplo: `@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`.

<div id="automate-with-workflows">
## Automatiza con flujos de trabajo
</div>

Crea flujos de trabajo para automatizar tareas recurrentes y tareas de mantenimiento reactivo, como redactar cambios o actualizar contenido cuando se agreguen nuevas funciones a tu producto.

Consulta [Workflows](/es/agent/workflows) para obtener más información.

<div id="automate-with-the-api">
## Automatiza con la API
</div>
Expand Down
114 changes: 73 additions & 41 deletions es/agent/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,47 @@
title: "Flujos de trabajo"
description: "Automatiza el mantenimiento de la documentación con tareas del agente programadas o activadas por eventos."
keywords: ["automation", "automate", "cron", "auto-update"]
tag: "Beta"
---

<Info>
Los flujos de trabajo están en beta. Ponte en contacto con nosotros directamente para habilitarlos.
Los flujos de trabajo están en beta. Actualmente están disponibles en los [planes Enterprise](https://mintlify.com/pricing).

[Ponte en contacto con nosotros](mailto:gtm@mintlify.com) para habilitar flujos de trabajo para tu organización.
</Info>

Los flujos de trabajo ejecutan el agente automáticamente de forma programada o cuando se realiza un push a un repositorio que especifiques. Cada flujo de trabajo define una instrucción para el agente y un disparador que indica cuándo ejecutarlo.
Los flujos de trabajo ejecutan el agente automáticamente de forma programada o cuando se realiza un push a un repositorio. Cada flujo de trabajo define una instrucción para el agente y un disparador que indica cuándo ejecutarlo.

Cuando se ejecuta un flujo de trabajo, el agente clona los repositorios especificados como contexto, sigue la instrucción y abre una solicitud de extracción o hace push directamente de los cambios a tu rama de implementación.

<div id="create-a-workflow-file">
## Crear un archivo de flujo de trabajo
Puedes tener hasta 10 flujos de trabajo activos. Cada flujo de trabajo puede ejecutarse hasta 20 veces al día. Las ejecuciones que fallan no cuentan para este límite.

<Tip>
Usa flujos de trabajo que se ejecutan de forma programada para automatizar tareas recurrentes como publicar registros de cambios o revisar problemas de gramática y estilo.

Usa flujos de trabajo que se ejecutan con eventos de push para automatizar tareas de mantenimiento reactivas como actualizar referencias de la API o identificar actualizaciones de documentación necesarias para nuevas funcionalidades.
</Tip>

<div id="create-a-workflow">
## Crear un flujo de trabajo
</div>

<div id="create-a-workflow-in-the-dashboard">
### Crear un flujo de trabajo en el dashboard
</div>

En la página [Workflows](https://dashboard.mintlify.com/products/workflows) de tu dashboard, haz clic en el botón **New workflow**.

<Frame>
<img src="/images/agent/new-workflow-light.png" alt="La página de configuración del nuevo flujo de trabajo." className="block dark:hidden" />
<img src="/images/agent/new-workflow-dark.png" alt="La página de configuración del nuevo flujo de trabajo." className="hidden dark:block" />
</Frame>

<div id="add-a-workflow-file-to-your-repository">
### Agrega un archivo de flujo de trabajo a tu repositorio
</div>

Crea archivos `.md` en un directorio `.mintlify/workflows/` en la raíz de tu repositorio de documentación. Cada archivo define un flujo de trabajo.
Crea un archivo `.md` para cada flujo de trabajo en un directorio `.mintlify/workflows/` en la raíz de tu repositorio de documentación. Cada archivo define un flujo de trabajo.

Los archivos de flujo de trabajo usan frontmatter YAML para configurar el flujo de trabajo, seguido de un prompt en Markdown para el agente.

Expand All @@ -41,7 +67,7 @@ Success criteria: Someone who reads the changelog knows the most up to date info


<div id="frontmatter-fields">
### Campos de frontmatter
## Campos de frontmatter
</div>

| Campo | Obligatorio | Descripción |
Expand All @@ -59,13 +85,13 @@ Debes tener la Aplicación de GitHub de Mintlify instalada en cada repositorio i
</Frame>

<div id="triggers">
## Disparadores
### Disparadores
</div>

Cada flujo de trabajo debe definir un único disparador mediante el campo `on`.

<div id="on-schedule-cron">
### Según programación (cron)
#### Según programación (cron)
</div>

Ejecuta un flujo de trabajo de forma recurrente usando una expresión cron. Todas las ejecuciones programadas se realizan en UTC.
Expand All @@ -86,8 +112,8 @@ El campo value es una expresión cron estándar de 5 campos con el formato `minu
| `"0 8 * * 1-5"` | Días laborables a las 8:00 AM UTC |


<div id="on-merge">
### Al hacer merge
<div id="on-push-events">
#### En eventos de push
</div>

Ejecuta un flujo de trabajo cuando se fusiona una solicitud de extracción en un repositorio y branch específicos.
Expand All @@ -113,8 +139,8 @@ on:
```


<div id="reference-repositories">
## Repositorios de referencia
<div id="context-repositories">
### Repositorios de contexto
</div>

Usa `context` para conceder al agente acceso de lectura a repositorios adicionales cuando se ejecuta el flujo de trabajo. Esto es útil cuando tu prompt requiere revisar código o contenido fuera de tu repositorio de documentación.
Expand All @@ -127,7 +153,7 @@ context:


<div id="auto-merge-changes">
## Combinación automática de cambios
### Combinación automática de cambios
</div>

De forma predeterminada, el agente abre una solicitud de extracción por cada ejecución del flujo de trabajo para que puedas revisar los cambios antes de que se publiquen. Establece `automerge: true` para enviar los cambios directamente a tu rama de implementación sin una solicitud de extracción.
Expand All @@ -152,65 +178,71 @@ Los prompts eficaces se centran en una sola tarea y buscan un resultado concreto
## Ejemplos de flujos de trabajo
</div>

<div id="style-audit">
### Auditoría de estilo
<div id="draft-documentation-for-new-features">
### Borrador de documentación para nuevas funcionalidades
</div>

Se ejecuta cuando se fusiona una solicitud de extracción de documentación para detectar violaciones de la guía de estilo antes de que se acumulen. Este flujo de trabajo de ejemplo corrige automáticamente las violaciones de la guía de estilo y enumera en el cuerpo de la solicitud de extracción aquellas que requieren criterio humano.
<Tip>
Si utilizas sugerencias del agente en tu dashboard, este flujo de trabajo replica ese comportamiento.

```markdown .mintlify/workflows/style-audit.md
Añade este flujo de trabajo, con las modificaciones que necesites para tu proyecto, para redactar automáticamente la documentación a medida que añades nuevas funcionalidades a tu producto.
</Tip>

Se ejecuta cuando las solicitudes de extracción se fusionan en el repositorio de tu producto para identificar las actualizaciones de documentación necesarias para cualquier nueva funcionalidad o API que se haya introducido.

```markdown .mintlify/workflows/draft-feature-docs.md
---
name: Style audit
name: Borrador de documentación para nuevas funciones
on:
push:
- repo: your-org/your-docs
- repo: your-org/your-product
branch: main
context:
- repo: your-org/your-docs
automerge: false
---

Review all MDX files changed in the last merged PR against the style guide at `path/to/style-guide`.
Revisa el diff del último PR fusionado en `your-org/your-product`. Identifica cualquier nueva función, API u otros cambios que requieran documentación.

Open a pull request to resolve any style violations that can be fixed automatically. For any edits that require judgment or nuance, note them in the PR body with the specific lines, rule violations, and suggested fixes.
Para cada nueva incorporación, redacta actualizaciones de documentación que expliquen qué hace, cuándo usarla y cómo configurarla. Incluye un ejemplo de código donde sea relevante.

Success criteria:
- All style violations have a proposed resolution.
- No new style violations are introduced.
Criterios de éxito: Tras leer la documentación nueva o actualizada, los usuarios comprenden qué es la función, si se aplica a las tareas que realizan y cómo usarla.

## Important
## Importante

- Do not change content meaning. Only correct style violations.
- Skip any files in language subdirectories (`es/`, `fr/`, `zh/`).
- Documenta solo los cambios que afecten a los usuarios finales. Omite refactorizaciones internas o actualizaciones de dependencias.
- Mantén el estilo y la estructura de las páginas de documentación existentes.
```


<div id="draft-documentation-for-new-features">
### Borrador de documentación para nuevas funcionalidades
<div id="style-audit">
### Auditoría de estilo
</div>

Se ejecuta cuando las solicitudes de extracción se fusionan en el repositorio de tu producto para identificar las actualizaciones de documentación necesarias para cualquier nueva funcionalidad o API que se haya introducido.
Se ejecuta cuando se fusiona una solicitud de extracción de documentación para detectar violaciones de la guía de estilo antes de que se acumulen. Este flujo de trabajo de ejemplo corrige automáticamente las violaciones de la guía de estilo y enumera en el cuerpo de la solicitud de extracción aquellas que requieren criterio humano.

```markdown .mintlify/workflows/draft-feature-docs.md
```markdown .mintlify/workflows/style-audit.md
---
name: Borrador de documentación para nuevas funciones
name: Style audit
on:
push:
- repo: your-org/your-product
- repo: your-org/your-docs
branch: main
context:
- repo: your-org/your-docs
automerge: false
---

Revisa el diff del último PR fusionado en `your-org/your-product`. Identifica cualquier nueva función, API u otros cambios que requieran documentación.
Review all MDX files changed in the last merged PR against the style guide at `path/to/style-guide`.

Para cada nueva incorporación, redacta actualizaciones de documentación que expliquen qué hace, cuándo usarla y cómo configurarla. Incluye un ejemplo de código donde sea relevante.
Open a pull request to resolve any style violations that can be fixed automatically. For any edits that require judgment or nuance, note them in the PR body with the specific lines, rule violations, and suggested fixes.

Criterios de éxito: Tras leer la documentación nueva o actualizada, los usuarios comprenden qué es la función, si se aplica a las tareas que realizan y cómo usarla.
Success criteria:
- All style violations have a proposed resolution.
- No new style violations are introduced.

## Importante
## Important

- Documenta solo los cambios que afecten a los usuarios finales. Omite refactorizaciones internas o actualizaciones de dependencias.
- Mantén el estilo y la estructura de las páginas de documentación existentes.
- Do not change content meaning. Only correct style violations.
- Skip any files in language subdirectories (`es/`, `fr/`, `zh/`).
```


Expand Down
11 changes: 6 additions & 5 deletions es/api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,16 @@ Si sus páginas de la API no se muestran correctamente, revise estos problemas d
</Accordion>

<Accordion title="Las solicitudes del área de pruebas de la API no funcionan">
Si tienes un domain personalizado configurado, esto podría deberse a un problema con tu proxy inverso. De forma predeterminada, las solicitudes realizadas a través del área de pruebas de la API comienzan con una solicitud `POST` a la
Si tienes un domain personalizado configurado, esto podría deberse a un problema con tu proxy inverso. De forma predeterminada,
las solicitudes realizadas a través del área de pruebas de la API comienzan con una solicitud `POST` a la
ruta `/_mintlify/api/request` en el sitio de documentación. Si tu proxy inverso está configurado para permitir únicamente solicitudes `GET`
entonces todas estas solicitudes fallarán. Para solucionarlo, configura tu proxy inverso para
permitir solicitudes `POST` a la ruta `/_mintlify/api/request`.

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#param-proxy). 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 entradas de navigation de OpenAPI no están generando páginas">
<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:

1. **Falta la especificación de OpenAPI predeterminada**: Asegúrate de tener definido un campo `openapi` en el elemento de navigation:
Expand Down Expand Up @@ -98,14 +99,14 @@ Si sus páginas de la API no se muestran correctamente, revise estos problemas d
<Accordion title="Algunas operaciones de OpenAPI aparecen en navigation, pero otras no">
1. **Operaciones ocultas**: Las operaciones marcadas con `x-hidden: true` en tu especificación de OpenAPI no aparecerán en la navigation generada automáticamente.
2. **Operaciones no válidas**: Las operaciones con errores de validación en la especificación de OpenAPI pueden omitirse. Revisa tu documento de OpenAPI para detectar errores de sintaxis.
3. **Inclusión manual vs. automática**: Si haces referencia a endpoints de una especificación de OpenAPI, solo las operaciones referenciadas explícitamente aparecerán en la navigation. No se agregarán otras páginas automáticamente. Esto incluye operaciones referenciadas en elementos secundarios de la navigation.
3. **Inclusión manual vs. automática**: Si haces referencia a endpoints de una especificación de OpenAPI, solo las operaciones referenciadas explícitamente aparecen en la navigation. No se agregan otras páginas automáticamente. Esto incluye operaciones referenciadas en elementos secundarios de la navigation.
</Accordion>

<Accordion title="La navigation combinada (páginas de OpenAPI y MDX) no funciona correctamente">
Al combinar operaciones de OpenAPI con páginas de documentación estándar en navigation:

1. **Conflictos de archivos**: No puedes tener a la vez un archivo `MDX` y una entrada en navigation para la misma operación. Por ejemplo, si tienes `get-users.mdx`, no incluyas también `"GET /users"` en tu navigation. Si necesitas un archivo que comparta nombre con una operación, usa la extensión `x-mint` del endpoint para que el href apunte a otra ubicación.
2. **Resolución de rutas**: Las entradas en navigation que no coincidan con operaciones de OpenAPI se tratarán como rutas de archivo. Asegúrate de que tus archivos `MDX` existan en las ubicaciones esperadas.
3. **Distinción entre mayúsculas y minúsculas**: La coincidencia de operaciones de OpenAPI distingue mayúsculas y minúsculas. Asegúrate de que los métodos HTTP estén en mayúsculas en las entradas de navigation.
2. **Resolución de rutas**: Las entradas en navigation que no coincidan con operaciones de OpenAPI se tratan como rutas de archivo. Asegúrate de que tus archivos `MDX` existan en las ubicaciones esperadas.
3. **Distinción entre mayúsculas y minúscculas**: La coincidencia de operaciones de OpenAPI distingue mayúsculas y minúsculas. Asegúrate de que los métodos HTTP estén en mayúsculas en las entradas de navigation.
</Accordion>
</AccordionGroup>
8 changes: 5 additions & 3 deletions es/components/mermaid-diagrams.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,14 @@ Para ver la lista completa de tipos de diagramas compatibles y su sintaxis, cons
```
````


<div id="elk-layout-support">
## Compatibilidad con diseño ELK
## Compatibilidad con el diseño ELK
</div>

Mintlify es compatible con el motor de diseño [ELK (Eclipse Layout Kernel)](https://www.eclipse.org/elk/) para diagramas de Mermaid. ELK optimiza la disposición para reducir superposiciones y mejorar la legibilidad, lo cual es útil para diagramas grandes o complejos.
Mintlify es compatible con el motor de diseño [ELK (Eclipse Layout Kernel)](https://www.eclipse.org/elk/) para diagramas Mermaid. ELK optimiza la disposición para reducir solapamientos y mejorar la legibilidad, lo cual es especialmente útil para diagramas grandes o complejos.

Para usar el diseño ELK en tus diagramas de Mermaid, agrega la directiva `%%{init: {'flowchart': {'defaultRenderer': 'elk'}}}%%` al comienzo de tu diagrama:
Para utilizar el diseño ELK en tus diagramas Mermaid, añade la directiva `%%{init: {'flowchart': {'defaultRenderer': 'elk'}}}%%` al principio de tu diagrama:

````mdx ELK layout example
```mermaid
Expand All @@ -68,6 +69,7 @@ flowchart LR
```
````


<div id="interactive-controls">
## Controles interactivos
</div>
Expand Down
2 changes: 1 addition & 1 deletion es/customize/custom-404-page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ Configura la página 404 en la sección `errors.404` de tu archivo `docs.json`:
</ResponseField>

<ResponseField name="description" type="string">
Descripción personalizada para la página de error 404. Admite formato Markdown.
Descripción personalizada para la página de error 404. Admite formato MDX, incluidos enlaces, texto en negrita y en cursiva, y componentes personalizados.
</ResponseField>
4 changes: 2 additions & 2 deletions es/deploy/ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ Este texto es ignorado por Vale
Vale reconoce y respeta automáticamente estos comentarios en los archivos MDX sin necesidad de configuración adicional. Usa los comentarios para omitir líneas o secciones que el linter deba ignorar.

<Warning>
No coloques `{/* vale off */}` u otros comentarios de expresión MDX similares como hijos directos de un componente JSX entre elementos hermanos. Por ejemplo, entre dos elementos `<Step>` dentro de un componente `<Steps>`.
No coloques `{/* vale off */}` o comentarios de expresión MDX similares como hijos directos de un componente JSX entre elementos hermanos. Por ejemplo, entre dos elementos `<Step>` dentro de un componente `<Steps>`.

Coloca los comentarios dentro del contenido de un elemento específico o reestructura el contenido para evitar la necesidad de comentarios.
</Warning>
4 changes: 2 additions & 2 deletions es/editor/keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ Usa estos atajos de teclado al editar en modo visual.
### Sustituciones inteligentes
</div>

El editor convierte automáticamente ciertas secuencias de caracteres en símbolos tipográficos mientras escribes. El editor omite las sustituciones dentro de bloques de código y código en línea.
El editor convierte automáticamente ciertas secuencias de caracteres en símbolos tipográficos a medida que escribes. El editor omite las sustituciones en los bloques de código y en el código en línea.

| Escribe | Resultado |
| Tipo | Resultado |
| :--- | :--- |
| `->` | → |
| `<-` | ← |
Expand Down
Loading