Aller au contenu principal

Travailler avec l'IA

La documentation d'Android Macro peut désormais être consommée de manière plus adaptée aux LLM.

Cela offre trois modèles d'accès différents :

  1. Ouvrez n'importe quelle page de documentation en Markdown brut en ajoutant .md
  2. Chargez l'index de documentation organisé depuis /llms.txt

Miroir Markdown​

Chaque route de documentation dispose désormais d'un miroir Markdown.

Exemple :

  • Page HTML : https://androidmacro.com/docs/basic/how-to-use
  • Page Markdown : https://androidmacro.com/docs/basic/how-to-use.md

C'est utile lorsque :

  • vous voulez coller une page dans un LLM
  • vous voulez qu'un agent récupère la version propre de la documentation au lieu d'analyser le HTML
  • vous voulez un texte stable pour le contexte du prompt

llms.txt​

La racine du site expose un index llms.txt :

https://androidmacro.com/llms.txt

Ce fichier est une carte organisée de la documentation destinée aux LLM. Il oriente les modèles et les outils vers les pages les plus importantes en premier, puis renvoie vers les versions Markdown de la documentation.

Fichiers associés :

  • https://androidmacro.com/llms-full.txt
  • https://androidmacro.com/llms-sitemap.txt

Utilisez-les comme ceci :

  • llms.txt pour un point de départ organisé
  • llms-full.txt lorsque vous voulez un export complet du corpus de documentation
  • llms-sitemap.txt lorsque vous voulez une liste d'URLs Markdown adaptée aux machines

Pourquoi c'est utile​

La documentation HTML est conçue pour les humains. Les LLM fonctionnent généralement mieux avec :

  • du Markdown au lieu du HTML complet d'une page
  • un index organisé au lieu d'explorer aveuglément chaque route

C'est pourquoi cette configuration utilise les deux :

  • des miroirs .md pour l'accès brut aux pages
  • la découverte de type llms.txt

Architecture actuelle​

Les miroirs Markdown et les fichiers llms.txt sont générés dans la sortie static de Docusaurus, ils sont donc déployés ensemble avec le site de documentation.

Remarques​

  • Les pages d'atterrissage de catégorie ont également des miroirs Markdown, par exemple https://androidmacro.com/docs/reference/storage.md
  • Le Markdown généré est conçu pour la consommation par les LLM, certains éléments interactifs sont donc remplacés par de courtes notes
  • Recompilez le site de documentation après les modifications de contenu pour que les miroirs Markdown et le llms.txt restent synchronisés

Pages associées​