Saltar al contenido principal

Trabajar con IA

La documentación de Android Macro ahora se puede consumir de una forma más amigable para los LLM.

Esto ofrece tres patrones de acceso diferentes:

  1. Abrir cualquier página de documentación como markdown puro añadiendo .md
  2. Cargar el índice de documentación curado desde /llms.txt

Espejo de Markdown​

Cada ruta de documentación tiene ahora un espejo en markdown.

Ejemplo:

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

Esto es útil cuando:

  • quieres pegar una página en un LLM
  • quieres que un agente obtenga la versión limpia de la documentación en lugar de analizar el HTML
  • quieres texto estable para el contexto del prompt

llms.txt​

La raíz del sitio expone un índice llms.txt:

https://androidmacro.com/llms.txt

Este archivo es un mapa curado de la documentación para uso de los LLM. Dirige a los modelos y herramientas primero hacia las páginas más importantes y luego enlaza con las versiones en markdown de la documentación.

Archivos relacionados:

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

Úsalos así:

  • llms.txt como punto de partida curado
  • llms-full.txt cuando quieras una gran exportación del corpus de documentación
  • llms-sitemap.txt cuando quieras una lista de URLs markdown apta para máquinas

Por qué ayuda​

La documentación HTML está diseñada para humanos. Los LLM suelen funcionar mejor con:

  • markdown en lugar del HTML completo de la página
  • un índice curado en lugar de rastrear cada ruta a ciegas

Por eso esta configuración usa ambos:

  • espejos .md para acceso directo a la página
  • descubrimiento estilo llms.txt

Arquitectura actual​

Los espejos de markdown y los archivos llms.txt se generan en la salida static de Docusaurus, por lo que se despliegan junto con el sitio de documentación.

Notas​

  • Las páginas de aterrizaje de categorías también obtienen espejos de markdown, como https://androidmacro.com/docs/reference/storage.md
  • El markdown generado está diseñado para consumo de LLM, por lo que algunos elementos interactivos se sustituyen por notas breves
  • Recompila el sitio de documentación después de cambios de contenido para que los espejos de markdown y llms.txt se mantengan sincronizados

Páginas relacionadas​