Перейти к основному содержимому

Работа с ИИ

Документация Android Macro теперь доступна в формате, удобном для LLM.

Это даёт вам три различных способа доступа:

  1. Откройте любую страницу документации как обычный markdown, добавив .md
  2. Загрузите подобранный индекс документации по адресу /llms.txt

Markdown-зеркало​

У каждого маршрута документации теперь есть markdown-зеркало.

Пример:

  • HTML-страница: https://androidmacro.com/docs/basic/how-to-use
  • Markdown-страница: https://androidmacro.com/docs/basic/how-to-use.md

Это полезно, когда:

  • вы хотите вставить страницу в LLM
  • вы хотите, чтобы агент получал чистую версию документации вместо разбора HTML
  • вам нужен стабильный текст для контекста промпта

llms.txt​

В корне сайта доступен индекс llms.txt:

https://androidmacro.com/llms.txt

Этот файл представляет собой подобранную карту документации для использования LLM. Он направляет модели и инструменты сначала к наиболее важным страницам, а затем даёт ссылки на markdown-версии документации.

Связанные файлы:

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

Используйте их следующим образом:

  • llms.txt — как подобранную отправную точку
  • llms-full.txt — когда нужен один большой экспорт корпуса документации
  • llms-sitemap.txt — когда нужен машиночитаемый список markdown-URL

Чем это полезно​

HTML-документация создана для людей. LLM обычно лучше работают с:

  • markdown вместо полного HTML-кода страницы
  • подобранным индексом вместо слепого обхода всех маршрутов

Именно поэтому эта конфигурация использует и то, и другое:

  • .md-зеркала для прямого доступа к страницам
  • обнаружение в стиле llms.txt

Текущая архитектура​

Markdown-зеркала и файлы llms.txt генерируются в выходной каталог static Docusaurus, поэтому они разворачиваются вместе с сайтом документации.

Примечания​

  • Markdown-зеркала также создаются для страниц категорий, например https://androidmacro.com/docs/reference/storage.md
  • Сгенерированный markdown предназначен для использования LLM, поэтому некоторые интерактивные вставки заменены краткими примечаниями
  • После изменения содержимого пересоберите сайт документации, чтобы markdown-зеркала и llms.txt оставались актуальными

Связанные страницы​