#ИИ

Rspress предоставляет следующие возможности, которые помогают ИИ понимать его функции, конфигурацию и лучшие практики, чтобы он мог более точно помогать в повседневной разработке и устранении проблем:

• Навыки агентов
• llms.txt
• Документация в Markdown
• AGENTS.md

#Навыки агентов

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

В репозитории rstackjs/agent-skills содержится множество навыков для экосистемы Rstack. Навыки, связанные с Rspress, включают:

• rspress-docs-generator: Рекомендуется для создания и сопровождения сайтов документации на Rspress, особенно если в монорепозитории документация вынесена в отдельный проект на Rspress.
• rspress-best-practices: Лучшие практики Rspress по настройке, CLI-процессам, организации контента, метаданным, MDX, темам, i18n, поиску, статическим ресурсам, развёртыванию и отладке.
• rspress-v2-upgrade: миграция проектов Rspress с v1 на v2.
• rspress-custom-theme: кастомизация тем Rspress с помощью CSS-переменных, слотов Layout, обёртки компонентов или их встраивания.
• rspress-description-generator: генерация и поддержка мета-поля description для файлов документации Rspress.

В агентах для программирования, поддерживающих навыки, вы можете использовать пакет skills для установки конкретного навыка с помощью следующей команды:

npx skills add rstackjs/agent-skills --skill rspress-docs-generator

yarn dlx skills add rstackjs/agent-skills --skill rspress-docs-generator

pnpm dlx skills add rstackjs/agent-skills --skill rspress-docs-generator

bunx skills add rstackjs/agent-skills --skill rspress-docs-generator

deno run -A npm:skills add rstackjs/agent-skills --skill rspress-docs-generator

После установки используйте запросы на естественном языке, чтобы активировать навык. Например:

Help me update the Rspress documentation project in this monorepo for the current feature branch

#llms.txt

llms.txt — это стандарт, который помогает LLM обнаруживать и использовать документацию проекта. Rspress следует этому стандарту и публикует следующие два файла:

• llms.txt: структурированный индекс, содержащий заголовки, ссылки и краткие описания всех страниц документации.

https://rspress.rs/llms.txt

• llms-full.txt: файл с полным содержимым, объединяющий полный контент каждой страницы документации в один файл.

https://rspress.rs/llms-full.txt

Вы можете выбрать файл, который лучше всего подходит для вашего случая использования:

• llms.txt меньше и потребляет меньше токенов, что делает его подходящим для получения ИИ конкретных страниц по требованию.
• llms-full.txt содержит полный контент документации, поэтому ИИ не нужно переходить по отдельным ссылкам — идеально, когда вам нужно, чтобы ИИ имел полное представление о Rspress, хотя он потребляет больше токенов и лучше всего работает с инструментами ИИ, поддерживающими большие контекстные окна.

Rspress также поддерживает встроенный режим SSG-MD, который может генерировать файлы, совместимые с llms.txt, для ваших собственных сайтов документации. Чтобы включить его, установите llms: true в конфигурации.

#Документация в Markdown

Каждая страница документации Rspress имеет соответствующую версию в формате .md (обычный текст), которую можно напрямую предоставить ИИ. На любой странице документации вы можете нажать «Скопировать Markdown» или «Скопировать ссылку Markdown» под заголовком, чтобы получить содержимое Markdown или ссылку на содержимое.

https://rspress.rs/guide/start/introduction.md

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

#AGENTS.md

Вы можете создать файл AGENTS.md в вашем проекте Rspress. Этот файл следует спецификации AGENTS.md и предоставляет агентам ключевую информацию о проекте.

Пример содержимого AGENTS.md:

# AGENTS.md

Вы эксперт в JavaScript, Rspress и разработке сайтов документации. Вы пишете поддерживаемый, производительный и доступный код.

## Команды

- `npm run dev` - Запуск сервера разработки
- `npm run build` - Сборка сайта для продакшена
- `npm run preview` - Просмотр продакшен-сборки локально

## Документация

- Rspress: https://rspress.rs/llms.txt
- Rsbuild: https://rsbuild.rs/llms.txt
- Rspack: https://rspack.rs/llms.txt

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

@AGENTS.md