Créer un fichier LLMs.txt à partir de la structure du repository

Créez un nouveau fichier llms.txt de zéro à la racine du repository en suivant la spécification officielle llms.txt sur https://llmstxt.org/. Ce fichier fournit des directives de haut niveau aux modèles de langage (LLMs) pour trouver le contenu pertinent permettant de comprendre l'objectif et les spécifications du repository.

Directive Principale

Créez un fichier llms.txt complet qui serve de point d'entrée aux LLMs pour comprendre et naviguer efficacement dans le repository. Le fichier doit respecter la spécification llms.txt et être optimisé pour la consommation par des LLMs tout en restant lisible par les humains.

Phase d'Analyse et de Planification

Avant de créer le fichier llms.txt, vous devez accomplir une analyse approfondie :

Étape 1 : Examiner la Spécification llms.txt

Examinez la spécification officielle sur https://llmstxt.org/ pour garantir la conformité complète
Comprenez la structure de format requise et les directives
Notez les exigences spécifiques de structure markdown

Étape 2 : Analyse de la Structure du Repository

Examinez la structure complète du repository à l'aide des outils appropriés
Identifiez l'objectif principal et la portée du repository
Cataloguez tous les répertoires importants et leurs finalités
Énumérez les fichiers clés qui seraient précieux pour la compréhension par les LLMs

Étape 3 : Découverte de Contenu

Identifiez les fichiers README et leurs emplacements
Trouvez les fichiers de documentation (fichiers .md dans /docs/, /spec/, etc.)
Localisez les fichiers de spécification et leurs finalités
Découvrez les fichiers de configuration et leur pertinence
Trouvez les fichiers d'exemple et les exemples de code
Identifiez la structure de documentation existante le cas échéant

Étape 4 : Créer un Plan d'Implémentation

Basé sur votre analyse, créez un plan structuré incluant :

Résumé de l'objectif et la portée du repository
Liste ordonnée par priorité des fichiers essentiels pour la compréhension par les LLMs
Fichiers secondaires fournissant un contexte supplémentaire
Structure organisationnelle pour le fichier llms.txt

Exigences d'Implémentation

Conformité de Format

Le fichier llms.txt doit suivre cette structure exacte selon la spécification :

En-tête H1 : Ligne unique avec le nom du repository/projet (obligatoire)
Résumé en Blockquote : Brève description au format blockquote (optionnel mais recommandé)
Détails Supplémentaires : Zéro ou plusieurs sections markdown sans en-têtes pour le contexte
Sections de Liste de Fichiers : Zéro ou plusieurs sections H2 contenant des listes markdown de liens

Exigences de Contenu

Éléments Obligatoires

Nom du Projet : Titre clair et descriptif en H1
Résumé : Blockquote concise expliquant l'objectif du repository
Fichiers Clés : Fichiers essentiels organisés par catégorie (sections H2)

Format du Lien de Fichier

Chaque lien de fichier doit suivre : [nom-descriptif](url-relative) : description optionnelle

Organisation des Sections

Organisez les fichiers en sections H2 logiques telles que :

Documentation : Fichiers de documentation principale
Spécifications : Spécifications techniques et exigences
Exemples : Exemples de code et d'utilisation
Configuration : Fichiers de configuration et d'installation
Optionnel : Fichiers secondaires (signification spéciale - peuvent être omis pour un contexte plus court)

Directives de Contenu

Langage et Style

Utilisez un langage concis, clair et sans ambiguïté
Évitez le jargon sans explication
Écrivez pour les lecteurs humains et les LLMs
Soyez spécifique et informatif dans les descriptions

Critères de Sélection de Fichiers

Incluez les fichiers qui :

Expliquent l'objectif et la portée du repository
Fournissent de la documentation technique essentielle
Montrent les exemples d'utilisation et les motifs
Définissent les interfaces et les spécifications
Contiennent les instructions de configuration et d'installation

Excluez les fichiers qui :

Sont purement des détails d'implémentation
Contiennent des informations redondantes
Sont des artefacts de build ou du contenu généré
Ne sont pas pertinents pour la compréhension du projet

Étapes d'Exécution

Étape 1 : Analyse du Repository

Examinez complètement la structure du repository
Lisez le README.md principal pour comprendre le projet
Identifiez tous les répertoires et fichiers de documentation
Cataloguez les fichiers de spécification et leurs finalités
Trouvez les fichiers d'exemple et les fichiers de configuration

Étape 2 : Planification du Contenu

Déterminez l'énoncé de l'objectif principal
Rédigez un résumé concis pour la blockquote
Groupez les fichiers identifiés en catégories logiques
Priorisez les fichiers par importance pour la compréhension par les LLMs
Créez des descriptions pour chaque lien de fichier

Étape 3 : Création du Fichier

Créez le fichier llms.txt à la racine du repository
Suivez la spécification de format exacte
Incluez toutes les sections requises
Utilisez le formatage markdown approprié
Assurez-vous que tous les liens sont des chemins relatifs valides

Étape 4 : Validation

Vérifiez la conformité avec la spécification https://llmstxt.org/
Vérifiez que tous les liens sont valides et accessibles
Assurez-vous que le fichier serve de tool de navigation efficace pour les LLMs
Confirmez que le fichier est lisible par les humains et les machines

Assurance Qualité

Validation de Format

✅ En-tête H1 avec le nom du projet
✅ Résumé en blockquote (s'il est inclus)
✅ Sections H2 pour les listes de fichiers
✅ Format de lien markdown approprié
✅ Pas de liens cassés ou invalides
✅ Formatage cohérent partout

Validation de Contenu

✅ Langage clair et sans ambiguïté
✅ Couverture complète des fichiers essentiels
✅ Organisation logique du contenu
✅ Descriptions de fichiers appropriées
✅ Serve de tool de navigation efficace pour les LLMs

Conformité de Spécification

✅ Suit exactement le format https://llmstxt.org/
✅ Utilise la structure markdown requise
✅ Implémente les sections optionnelles convenablement
✅ Fichier situé à la racine du repository (/llms.txt)

Exemple de Modèle de Structure

# [Repository Name]

> [Brève description de l'objectif et la portée du repository]

[Paragraphes de contexte supplémentaires optionnels sans en-têtes]

## Documentation

- [Main README](README.md): Documentation de projet principale et guide de démarrage
- [Contributing Guide](CONTRIBUTING.md): Directives pour contribuer au projet
- [Code of Conduct](CODE_OF_CONDUCT.md): Directives communautaires et attentes

## Specifications

- [Technical Specification](spec/technical-spec.md): Exigences techniques détaillées et contraintes
- [API Specification](spec/api-spec.md): Définitions d'interface et contrats de données

## Examples

- [Basic Example](examples/basic-usage.md): Démonstration simple d'utilisation
- [Advanced Example](examples/advanced-usage.md): Motifs de mise en œuvre complexes

## Configuration

- [Setup Guide](docs/setup.md): Instructions d'installation et de configuration
- [Deployment Guide](docs/deployment.md): Directives de déploiement en production

## Optional

- [Architecture Documentation](docs/architecture.md): Architecture système détaillée
- [Design Decisions](docs/decisions.md): Enregistrements historiques des décisions de conception

Critères de Succès

Le fichier llms.txt créé doit :

Permettre aux LLMs de comprendre rapidement l'objectif du repository
Fournir une navigation claire vers la documentation essentielle
Suivre exactement la spécification officielle llms.txt
Être complet mais concis
Servir efficacement les lecteurs humains et les machines
Inclure tous les fichiers critiques pour la compréhension du projet
Utiliser un langage clair et sans ambiguïté partout
Organiser le contenu logiquement pour une consommation facile

create-llms