De la fonction à sa documentation

What you will build

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.

Before you start

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.

Your turn

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.

To import the file: in the Bloxmith editor, open the Actionsmenu, choose Insert blueprint JSON and select the downloaded file. The blocks are added to the open blueprint.