Générateur llms.txt
Générez des fichiers llms.txt et llms-full.txt qui fournissent un accès LLM-friendly à la documentation wiki, en respectant la spécification llms.txt.
Quand cette skill s'active
- L'utilisateur demande de générer
llms.txtou mentionne le standard llms.txt - L'utilisateur veut rendre la documentation « LLM-friendly » ou « LLM-readable »
- L'utilisateur demande un fichier de résumé de projet pour les modèles de langage
- L'utilisateur mentionne
llms-full.txtou une documentation en contexte étendu
Résolution du dépôt source (À FAIRE EN PREMIER)
Avant de générer, résolvez le contexte du dépôt source :
- Vérifiez la remote git : Exécutez
git remote get-url origin - Demandez à l'utilisateur : « S'agit-il d'un dépôt local uniquement, ou avez-vous une URL de dépôt source ? »
- URL distante → stockez comme
REPO_URL - Local → utilisez uniquement les chemins relatifs
- URL distante → stockez comme
- Déterminez la branche par défaut : Exécutez
git rev-parse --abbrev-ref HEAD - Ne PROCÉDEZ PAS tant que ce n'est pas résolu
Format llms.txt (conforme à la spécification)
Le fichier suit la spécification llms.txt :
# {Project Name}
> {Résumé dense d'un paragraphe — ce qu'il fait, à qui c'est destiné, technologies clés}
{Paragraphes de contexte importants — contraintes, philosophie architecturale, choses non évidentes}
## {Section Name}
- [{Page Title}]({relative-path-to-md}): {Description d'une phrase de ce que le lecteur apprendra}
## Optional
- [{Page Title}]({relative-path-to-md}): {Description — celles-ci peuvent être omises pour un contexte plus court}
Règles clés
- H1 — Nom du projet (exactement un, obligatoire)
- Blockquote — Résumé dense et spécifique (obligatoire). Doit être unique à CE projet.
- Paragraphes de contexte — Contraintes non évidentes, choses que les LLM se tromperaient sans être prévenues
- Sections H2 — Organisées par sujet, chacune avec une liste d'entrées
[Title](url): Description - H2 « Optional » — Signification spéciale : les liens ici peuvent être omis pour un contexte plus court
- Liens relatifs — Tous les chemins relatifs au répertoire wiki
- Dynamique — TOUT le contenu dérivé des pages wiki réelles, pas de templates
- Ordre des sections — Plus important en premier : Onboarding → Architecture → Getting Started → Deep Dive → Optional
Qualité de la description
| ❌ Mauvais | ✅ Bon |
|---|---|
| « Architecture overview » | « Architecture système montrant comment les grains Orleans communiquent via message passing avec livraison au moins une fois » |
| « Getting started guide » | « Prérequis, configuration du développement local avec Docker Compose, et première procédure d'appel API » |
| « The API reference » | « Endpoints REST avec exigences d'authentification, limites de débit, et schémas de requête/réponse » |
Format llms-full.txt
Même structure que llms.txt mais avec le contenu complet intégré :
# {Project Name}
> {Même résumé}
{Même contexte}
## {Section Name}
<doc title="{Page Title}" path="{relative-path}">
{Contenu markdown complet — frontmatter supprimé, citations et diagrammes préservés}
</doc>
Règles d'intégration
- Supprimez le frontmatter YAML (blocs
---) de chaque page - Préservez les diagrammes Mermaid — gardez les délimiteurs
```mermaidintacts - Préservez les citations — tous les liens
[file:line](URL)restent tels quels - Préservez les tableaux — tous les tableaux markdown restent intacts
- Préservez les commentaires
<!-- Sources: -->— ceux-ci fournissent la provenance des diagrammes
Prérequis
Cette skill fonctionne mieux quand les pages wiki existent déjà (via /deep-wiki:generate ou /deep-wiki:page). Si aucun wiki n'existe encore :
- Suggérez d'exécuter
/deep-wiki:generateen premier - OU générez un
llms.txtminimal à partir du README + scan du code source (sans liens vers les pages wiki)
Fichiers de sortie
Générez trois fichiers :
| Fichier | Objectif | Découvrabilité |
|---|---|---|
./llms.txt |
Fichier de découverte racine | Chemin standard selon la spécification llms.txt. GitHub MCP get_file_contents et search_code trouvent ceci en premier. |
wiki/llms.txt |
Liens relatifs au wiki | Pour le déploiement VitePress et la navigation interne du wiki. |
wiki/llms-full.txt |
Contenu complet intégré | Référence complète pour les agents ayant besoin de toute la documentation en un seul fichier. |
Le fichier ./llms.txt racine se lie dans wiki/ (par ex., [Guide](./wiki/onboarding/contributor-guide.md)). Le wiki/llms.txt utilise des chemins relatifs au wiki (par ex., [Guide](./onboarding/contributor-guide.md)).
Si un llms.txt racine existe déjà et n'a PAS été généré par deep-wiki, ne le remplacez PAS.
Liste de validation
Avant la finalisation :
- [ ] Tous les fichiers liés dans
llms.txtexistent réellement - [ ] Tous les blocs
<doc>dansllms-full.txtont un contenu réel (pas vides) - [ ] La blockquote est spécifique à ce projet (pas du boilerplate générique)
- [ ] Les sections sont ordonnées par importance
- [ ] Aucune entrée de page dupliquée entre les sections
- [ ] La section « Optional » contient uniquement du contenu vraiment optionnel
- [ ]
llms.txtest concis (1-5 KB) - [ ]
llms-full.txtcontient toutes les pages wiki