Configuration de Windsurf

Configurez l'assistant Cascade AI de Windsurf pour vous aider à rédiger et maintenir votre documentation. Ce guide explique comment configurer Windsurf spécifiquement pour votre flux de travail de documentation Mintlify.

Prérequis

• Windsurf installé
• Accès à votre dépôt de documentation

Règles d'espace de travail

Créez des règles d'espace de travail qui fournissent à Windsurf le contexte de votre projet de documentation et vos normes.

Créez .windsurf/rules.md à la racine de votre projet :

# Règle de rédaction technique Mintlify

## Contexte du projet

- Il s'agit d'un projet de documentation sur la plateforme Mintlify
- Nous utilisons des fichiers MDX avec préambule YAML  
- La navigation est configurée dans `docs.json`
- Nous suivons les meilleures pratiques de rédaction technique

## Normes de rédaction

- Utilisez la deuxième personne (« vous ») pour les instructions
- Écrivez à la voix active et au présent
- Commencez les procédures par les prérequis
- Incluez les résultats attendus pour les grandes étapes
- Utilisez des titres descriptifs et riches en mots-clés
- Gardez les phrases concises mais informatives

## Structure de page obligatoire

Chaque page doit commencer par un préambule :

```yaml
title: "Titre clair et spécifique"
description: "Description concise pour le SEO et la navigation"
```

## Composants Mintlify

### Appels

- `<Note>` pour les informations supplémentaires utiles
- `<Warning>` pour les avertissements importants et les changements de rupture
- `<Tip>` pour les meilleures pratiques et les conseils d'experts  
- `<Info>` pour les informations contextuelles neutres
- `<Check>` pour les confirmations de succès

### Exemples de code

- Le cas échéant, incluez des exemples complets et exécutables
- Utilisez `<CodeGroup>` pour les exemples dans plusieurs langages
- Spécifiez les balises de langue sur tous les blocs de code
- Incluez des données réalistes, pas des espaces réservés
- Utilisez `<RequestExample>` et `<ResponseExample>` pour les documents API

### Procédures

- Utilisez le composant `<Steps>` pour les instructions séquentielles
- Incluez les étapes de vérification avec les composants `<Check>` si pertinent
- Divisez les procédures complexes en étapes plus petites

### Organisation du contenu

- Utilisez `<Tabs>` pour le contenu spécifique à la plateforme
- Utilisez `<Accordion>` pour la divulgation progressive
- Utilisez `<Card>` et `<CardGroup>` pour mettre en évidence le contenu
- Enveloppez les images avec des composants `<Frame>` et du texte alternatif descriptif

## Exigences de documentation API

- Documentez tous les paramètres avec `<ParamField>` 
- Montrez la structure de la réponse avec `<ResponseField>`
- Incluez les exemples de succès et d'erreur
- Utilisez `<Expandable>` pour les propriétés d'objet imbriquées
- Incluez toujours les exemples d'authentification

## Normes de qualité

- Testez tous les exemples de code avant publication
- Utilisez les chemins relatifs pour les liens internes
- Incluez le texte alternatif pour toutes les images
- Assurez une hiérarchie de titre appropriée (commencez par h2)
- Vérifiez la cohérence avec les modèles existants