llms.txt

ADP предоставляет машиночитаемую документацию по стандарту llms.txt. Это позволяет AI-ассистентам (Claude, ChatGPT, Cursor, Copilot и другим) быстро разобраться в проекте и давать точные ответы о нём.

Что такое llms.txt?

llms.txt — открытый стандарт, предложенный Jeremy Howard (fast.ai). Он определяет известный URL (/llms.txt), по которому сайт отдаёт документацию в чистом markdown-формате, оптимизированном для LLM — без HTML, JavaScript и навигационного мусора.

Доступные файлы

Файл	URL	Содержимое
llms.txt	/llms.txt	Краткое оглавление со ссылками на .md файлы каждой страницы
llms-full.txt	/llms-full.txt	Вся документация в одном файле
*.md (постранично)	напр. /guide/collectors.md	Чистый markdown для отдельной страницы

llms.txt — лёгкий индекс с заголовками и ссылками. Используйте, когда у AI-инструмента ограничено окно контекста или нужен быстрый обзор.

llms-full.txt — полная документация одним файлом (~13K токенов). Используйте, когда у AI-инструмента большое окно контекста и нужны исчерпывающие ответы.

Постраничные .md файлы доступны для каждой страницы документации. Используйте, когда нужна информация по конкретной теме без загрузки всей документации.

Как использовать

В Claude (claude.ai)

Вставьте URL в чат:

Прочитай https://app-dev-panel.github.io/app-dev-panel/llms-full.txt и ответь на мои вопросы об ADP.

В Claude Code

Используйте инструмент WebFetch или вставьте URL:

Fetch https://app-dev-panel.github.io/app-dev-panel/llms-full.txt

В Cursor / Copilot / других IDE-ассистентах

Добавьте URL как источник документации в настройках IDE или вставьте в контекст чата.

В кастомных агентах

Загрузите файл программно и включите в системный промпт:

import httpx

response = httpx.get("https://app-dev-panel.github.io/app-dev-panel/llms-full.txt")
docs = response.text

messages = [
    {"role": "system", "content": f"ADP documentation:\n\n{docs}"},
    {"role": "user", "content": "Как добавить свой коллектор?"},
]

Что внутри

Оба файла генерируются автоматически при сборке из тех же markdown-источников, что и этот сайт. Они включают:

• Начало работы — установка для каждого фреймворка
• Архитектура — слои, поток данных, система прокси
• Коллекторы — все 28 коллекторов с описаниями
• Справочник API — REST-эндпоинты, SSE, Inspector API
• Адаптеры — Symfony, Yii 2, Yii 3, Laravel
• MCP-сервер — настройка AI-интеграции
• CLI — команды и опции

Контент синхронизируется автоматически — при обновлении страницы документации следующая сборка регенерирует оба файла.

Как это работает

Работает на vitepress-plugin-llms — тот же плагин, что используют Vite, Vue.js и Vitest.

Плагин работает как Vite-плагин при сборке:

1. Собирает все markdown-файлы во время transform-фазы Vite
2. Очищает контент через remark AST — убирает frontmatter, HTML, Vue-компоненты
3. Генерирует llms.txt (оглавление), llms-full.txt (конкатенация) и постраничные .md файлы
4. Вставляет скрытые подсказки на HTML-страницы, указывающие LLM на .md версии

Включаются только английские страницы. Русские переводы исключены через ignoreFiles: ['ru/**'].

Конфигурация: config.ts