> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-add-i-to-quickstart-8818.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Windsurf
> Configura Windsurf para que sea tu asistente de escritura
Convierte Windsurf en un experto en documentación que comprende tu guía de estilo, tus componentes y el contexto de tu proyecto mediante reglas del espacio de trabajo y memorias.
## Usar Windsurf con Mintlify
El Asistente de IA Cascade de Windsurf se puede ajustar para redactar documentación conforme a tus estándares utilizando componentes de Mintlify. Las reglas del espacio de trabajo y las memorias proporcionan contexto persistente sobre tu proyecto, lo que garantiza sugerencias más coherentes de Cascade.
* **Reglas del espacio de trabajo**: se almacenan en tu repositorio de documentación y se comparten con tu equipo.
* **Memorias**: proporcionan contexto individual que se acumula con el tiempo.
Recomendamos configurar reglas del espacio de trabajo para definir estándares de documentación compartidos. Puedes desarrollar memorias a medida que trabajas, pero como no se comparten, no serán coherentes entre los miembros del equipo.
Crea reglas del espacio de trabajo en el directorio `.windsurf/rules` de tu repositorio de documentación. Consulta [Memories & Rules](https://docs.windsurf.com/windsurf/cascade/memories) en la documentación de Windsurf para obtener más información.
## Regla de espacio de trabajo de ejemplo
Esta regla proporciona a Cascade contexto sobre los componentes de Mintlify y las mejores prácticas generales de documentación técnica.
Puedes usar esta regla de ejemplo tal como está o personalizarla para tu documentación:
* **Estándares de redacción**: Actualiza las pautas de lenguaje para alinearlas con tu guía de estilo.
* **Patrones de componentes**: Añade componentes específicos del proyecto o modifica los ejemplos existentes.
* **Ejemplos de código**: Sustituye los ejemplos genéricos por llamadas y respuestas reales de tu API para tu producto.
* **Preferencias de estilo y tono**: Ajusta la terminología, el formato y otras reglas.
Guarda la regla como un archivo `.md` en el directorio `.windsurf/rules` del repositorio de tu documentación.
````mdx
# Norma de redacción técnica de Mintlify
## Contexto del proyecto
- Este es un proyecto de documentación en la plataforma Mintlify
- Usamos archivos MDX con frontmatter en YAML
- La navegación se configura en `docs.json`
- Seguimos las mejores prácticas de redacción técnica
## Estándares de redacción
- Usa la segunda persona ("tú") para las instrucciones
- Escribe en voz activa y en tiempo presente
- Inicia los procedimientos con requisitos previos
- Incluye los resultados esperados para los pasos principales
- Usa encabezados descriptivos y con palabras clave
- Mantén las frases concisas pero informativas
## Estructura de página requerida
Cada página debe comenzar con frontmatter:
```yaml
---
title: "Título claro y específico"
description: "Descripción concisa para SEO y la navegación"
---
```
## Componentes de Mintlify
### docs.json
- Consulta el [esquema de docs.json](https://mintlify.com/docs.json) al crear el archivo docs.json y la navegación del sitio
### Avisos
- `` para información complementaria útil
- `` para advertencias importantes y cambios incompatibles
- `` para buenas prácticas y consejos de expertos
- `` para información contextual neutral
- `` para confirmaciones de éxito
### Ejemplos de código
- Cuando corresponda, incluye ejemplos completos y ejecutables
- Usa `` para ejemplos en varios lenguajes
- Especifica etiquetas de lenguaje en todos los bloques de código
- Incluye datos realistas, no marcadores de posición
- Usa `` y `` para la documentación de API
### Procedimientos
- Usa el componente `` para instrucciones secuenciales
- Incluye pasos de verificación con componentes `` cuando corresponda
- Divide los procedimientos complejos en pasos más pequeños
### Organización del contenido
- Usa `` para contenido específico de plataforma
- Usa `` para divulgación progresiva
- Usa `` y `` para destacar contenido
- Envuelve las imágenes en componentes `` con texto alternativo descriptivo
## Requisitos de documentación de API
- Documenta todos los parámetros con ``
- Muestra la estructura de la respuesta con ``
- Incluye ejemplos de éxito y de error
- Usa `` para propiedades de objetos anidados
- Incluye siempre ejemplos de autenticación
## Estándares de calidad
- Prueba todos los ejemplos de código antes de publicar
- Usa rutas relativas para enlaces internos
- Incluye texto alternativo para todas las imágenes
- Garantiza una jerarquía de encabezados adecuada (comienza con h2)
- Revisa los patrones existentes para mantener la coherencia
````
## Trabajar con Cascade
Una vez que hayas configurado tus reglas, puedes usar Cascade para ayudarte con diversas tareas de documentación. Consulta [Cascade](https://docs.windsurf.com/windsurf/cascade) en la documentación de Windsurf para obtener más información.
### Ejemplos de prompts
**Redacción de contenido nuevo**:
```text ajustar
Crea una nueva página que explique cómo autenticarse en nuestra API. Incluye ejemplos de código en JavaScript, Python y cURL.
```
**Mejorar el contenido existente**:
```text ajuste
Revisa esta página y sugiere mejoras para la claridad y el uso de componentes. Concéntrate en que los pasos sean más fáciles de seguir.
```
**Creación de ejemplos de código**:
```text ajustar
Genera un ejemplo de código completo que muestre el manejo de errores para este endpoint de API. Usa datos realistas e incluye las respuestas esperadas.
```
**Mantener la consistencia**:
```text ajustar
Verifica si esta nueva página cumple con nuestros estándares de documentación y sugiere los cambios necesarios.
```