De la fonction à sa documentation

Ce que vous allez construire

Un modèle simple pour préparer une documentation technique en Markdown. L’agent explique le comportement observable du code, décrit les paramètres et propose un exemple d’utilisation. Il doit distinguer ce que le code montre et ce qui reste à vérifier.

Avant de commencer

Bloxmith et Codex CLI installé et authentifié. Renseignez le répertoire de travail de Codex. Cet exemple prépare du texte ; il ne modifie aucun fichier de votre projet par lui-même.

À vous de jouer

1. Collez une fonction et son contexte dans le bloc Code.
2. Configurez Codex et indiquez vos conventions documentaires dans la consigne de sortie.
3. Lancez le blueprint, puis vérifiez les exemples avant de les intégrer à votre documentation.

Pour importer le fichier : dans l’éditeur Bloxmith, ouvrez le menu Actions, choisissez Insert blueprint JSON et sélectionnez le téléchargement. Les blocs sont ajoutés au blueprint ouvert.