Documentation pour les assistants IA
La même documentation en Markdown brut, pour ChatGPT, Claude, Cursor et vos propres agents.
Un assistant qui lit ces pages en HTML reçoit la navigation, les scripts et la mise en forme avec le texte, et perd les exemples de code dessinés par des composants. Chaque page est donc aussi servie en Markdown brut, et toute la documentation en un seul fichier : vous donnez à l'assistant exactement le texte qu'une personne lit.
Trois points d'entrée
| Adresse | Ce qu'elle contient | Quand l'utiliser |
|---|---|---|
/llms.txt | Un plan : chaque page avec son titre, sa description et son adresse, rangée comme dans la navigation (llmstxt.org) | L'assistant va chercher les pages lui-même et doit savoir laquelle lire |
/fr/llms-full.txt | Toutes les pages de la documentation, puis la référence de l'API, en Markdown dans un seul fichier. En anglais : /llms-full.txt | Vous collez ou envoyez la documentation une fois, ou vous l'indexez dans votre propre outil |
<page>.md | Une seule page en Markdown | Vous voulez un sujet dans le contexte, et rien d'autre |
Ajoutez .md à l'adresse de n'importe quelle page, dans les deux langues et dans la référence de
l'API :
curl https://docs.wajub.com/fr/developer-tools/webhooks/signature-verification.md
curl https://docs.wajub.com/payments.md
curl https://docs.wajub.com/fr/api/transfers/create.mdChaque page HTML annonce aussi sa version Markdown avec
<link rel="alternate" type="text/markdown">, pour qu'un robot qui la cherche la trouve.
Ce que le Markdown garde
Le texte est celui de la page, écrit comme une personne l'écrirait à la main :
- Les exemples de code sont des blocs délimités avec leur langage, chaque onglet d'un exemple en plusieurs langages compris.
- Les encadrés sont des citations qui commencent par
[!NOTE],[!TIP],[!WARNING]ou[!CAUTION], titre compris. - Les étapes sont une liste numérotée, les tableaux de paramètres une liste de champs avec leur type et leur caractère obligatoire.
- Les schémas, comme un cycle de statuts ou une décision de routage, deviennent leurs étapes en toutes lettres.
- Les liens sont absolus : ils marchent encore une fois le texte collé ailleurs.
Une page de la référence de l'API donne l'endpoint, ses paramètres, les champs du corps, ses réponses et un exemple de réponse, lus dans le même document OpenAPI que la page.
Les aperçus interactifs et les illustrations n'ont pas de texte à donner et sont laissés de côté.
Écrire une intégration avec un agent de code
Donner une page à l'agent lui apporte des faits. Les Agent Skills
lui donnent les règles qu'il devinerait sinon, comme event plutôt que event.type ou la
vérification de la signature avant la lecture du corps. Utilisez les deux.
À garder en tête
- Ces fichiers sont reconstruits à chaque déploiement de la documentation. Un assistant qui a gardé
/llms-full.txtdu mois dernier peut décrire une version de l'API qui a changé depuis : faites-le relire plutôt que de garder une copie. - Les produits encore en préversion, pas encore publiés ici, n'y figurent pas non plus.
- Un assistant peut se tromper sur ce qu'il a lu. Avant la mise en production, vérifiez son code avec la page d'où il vient et testez-le en sandbox.