> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt
> Use this file to discover all available pages before exploring further.
# Windsurf
> Configura Windsurf para que sea tu assistant de redacción.
Convierte Windsurf en un experto en documentación que comprenda tu guía de estilo, tus componentes y el contexto de tu proyecto mediante workspace rules y memories.
## Uso de Windsurf con Mintlify
El assistant Cascade de IA 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 consistentes 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 unificar los estándares de documentación. Puedes desarrollar memorias a medida que trabajas, pero como no se comparten, no serán consistentes 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 ejemplo para el espacio de trabajo
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 cual 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**: Agrega componentes específicos del proyecto o modifica los ejemplos existentes.
* **Ejemplos de código**: Reemplaza los ejemplos genéricos con llamadas y respuestas reales de la API para tu producto.
* **Preferencias de estilo y tono**: Ajusta la terminología, el formato y otras reglas.
Guarda tu regla como un archivo `.md` en el directorio `.windsurf/rules` de tu repositorio de documentación.
````mdx theme={null}
# Regla 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 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 segunda persona ("tú") para las instrucciones
- Escribe en voz activa y tiempo presente
- Comienza los procedimientos con prerrequisitos
- Incluye resultados esperados para los pasos principales
- Usa encabezados descriptivos y ricos en palabras clave
- Mantén las oraciones 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 navegación"
---
```
## Componentes de Mintlify
### docs.json
- Consulta el [esquema de docs.json](https://mintlify.com/docs.json) al construir el archivo docs.json y la navegación del sitio
### Llamadas de atención
- `` para información suplementaria útil
- `` para precauciones importantes y cambios disruptivos
- `` para mejores prácticas y consejos de expertos
- `` para información contextual neutral
- `` para confirmaciones de éxito
### Ejemplos de código
- Cuando sea apropiado, incluye ejemplos completos y ejecutables
- Usa `` para ejemplos de múltiples lenguajes
- Especifica etiquetas de lenguaje en todos los bloques de código
- Incluye datos realistas, no marcadores de posición
- Usa `` y `` para documentación de API
### Procedimientos
- Usa el componente `` para instrucciones secuenciales
- Incluye pasos de verificación con componentes `` cuando sea relevante
- Divide procedimientos complejos en pasos más pequeños
### Organización de contenido
- Usa `` para contenido específico de plataforma
- Usa `` para divulgación progresiva
- Usa `` y `` para resaltar contenido
- Envuelve imágenes en componentes `` con texto alternativo descriptivo
## Requisitos de documentación de API
- Documenta todos los parámetros con ``
- Muestra la estructura de respuesta con ``
- Incluye ejemplos tanto de éxito como de error
- Usa `` para propiedades de objetos anidados
- Siempre incluye 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
- Asegura una jerarquía de encabezados adecuada (comienza con h2)
- Verifica patrones existentes para mantener consistencia
````
## Trabajar con Cascade
Una vez que tengas tus reglas configuradas, puedes usar Cascade para asistir en 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 indicaciones
**Redacción de contenido nuevo**:
```text wrap theme={null}
Crea una nueva página que explique cómo autenticarse con nuestra API. Incluye ejemplos de código en JavaScript, Python y cURL.
```
**Mejorar el contenido existente**:
```text wrap theme={null}
Revisa esta página y sugiere mejoras para mayor claridad y uso de componentes. Concéntrate en hacer que los pasos sean más fáciles de seguir.
```
**Creación de ejemplos de código**:
```text wrap theme={null}
Genera un ejemplo de código completo que muestre el manejo de errores para este endpoint de API. Utiliza datos realistas e incluye las respuestas esperadas.
```
**Mantener la consistencia**:
```text wrap theme={null}
Verifica si esta nueva página cumple con nuestros estándares de documentación y sugiere los cambios necesarios.
```