LLMs.txt - Bitrix24 JS SDK

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

LLMs.txt — это формат структурированной документации, разработанный специально для больших языковых моделей (LLM). Bitrix24 JS SDK предоставляет LLMs.txt-файлы с исчерпывающей информацией о библиотеке, чтобы AI-инструментам было проще понимать и помогать в разработке с Bitrix24 JS SDK.

Эти файлы оптимизированы для потребления AI и содержат структурированную информацию о компонентах, API, паттернах использования и лучших практиках.

Доступные маршруты

Мы предоставляем LLMs.txt-маршруты, чтобы AI-инструменты могли обращаться к документации:

/llms.txt — содержит структурированный обзор всех компонентов и ссылки на их документацию (~5К токенов)
/llms-full.txt — предоставляет исчерпывающую документацию, включая детали реализации, примеры, тематизацию, composables и руководство по миграции (~1М+ токенов)

Выбор подходящего файла

Большинству пользователей следует начать с /llms.txt — он содержит всю необходимую информацию и работает со стандартными контекстными окнами LLM.Используйте /llms-full.txt только если вам нужны исчерпывающие примеры реализации, а ваш AI-инструмент поддерживает большие контексты (200К+ токенов).

Важные замечания по использованию

Символ @ нужно вводить вручную — при использовании Cursor или Windsurf символ @ необходимо набирать руками в интерфейсе чата. Копирование-вставка ломает распознавание этого символа как контекстной ссылки.

Использование с AI-инструментами

Cursor

Bitrix24 JS SDK предоставляет специализированные LLMs.txt-файлы, на которые можно ссылаться в Cursor для улучшения AI-помощи в разработке компонентов.

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

Прямая ссылка: упоминайте URL'ы LLMs.txt при формулировке вопросов
Добавьте эти URL'ы в контекст проекта через @docs

Подробнее о Cursor Web and Docs Search

Windsurf

Windsurf может напрямую обращаться к LLMs.txt-файлам Bitrix24 JS SDK для понимания использования компонентов и лучших практик.

Использование LLMs.txt с Windsurf:

Используйте @docs для ссылки на конкретные URL'ы LLMs.txt
Создавайте постоянные правила, ссылающиеся на эти URL'ы, в вашем workspace

Подробнее о Windsurf Web and Docs Search

Другие AI-инструменты

Любой AI-инструмент с поддержкой LLMs.txt может использовать эти маршруты для лучшего понимания Bitrix24 JS SDK.

Примеры для ChatGPT, Claude и других LLM:

«Используя документацию Bitrix24 JS SDK из https://bitrix-tools.github.io/b24jssdk/llms.txt»
«Следуйте полному руководству Bitrix24 JS SDK из https://bitrix-tools.github.io/b24jssdk/llms-full.txt»

Навыки

Узкоспециализированные skill-файлы для AI-агентов разработчика, работающих с @bitrix24/b24jssdk.