Към съдържанието

Интеграция с ИИ

Blockstudio включва два контекстни файла за асистенти за програмиране. Първият е компактен индекс на документацията. Вторият съдържа пълния текст на всеки документ и схема за инструменти, които искат целия корпус в една заявка.

Агентът прочита индекса, намира необходимия му документ и го отваря. Алтернативата е да му се подаде половин мегабайт неструктуриран текст, в който нищо не може да бъде адресирано и всичко се зарежда, независимо дали е уместно.

Индексът

blockstudio-llm.txt изброява всеки публикуван документ по веднъж, групиран според раздела и подраздела, към които принадлежи, в реда на навигацията. Всеки запис съдържа:

  • route: URL на документацията.
  • file: пътя до изходния файл Markdown в хранилището Blockstudio.
  • purpose: един ред, описващ предназначението на документа.
  • settings: пътищата blockstudio.json, които документът управлява.
  • hooks: имената на филтрите и действията PHP и JavaScript, които управлява.
  • php: функциите, класовете и методите, които управлява.
  • cli: командите, които управлява.
Text
## Docs / Dev / Inspection Tools

### Canvas
route: /docs/dev/canvas
file: docs/docs/dev/canvas.md
purpose: A visual workspace and public inventory API for Blockstudio content.
settings: dev/canvas/enabled, ui
hooks: blockstudio/settings/dev/canvas/admin_bar, blockstudio/settings/dev/canvas/enabled
php: Blockstudio\Canvas, Canvas::documents(), Canvas::inventory()

Ред за идентификатор се записва само когато документът действително управлява нещо от този вид, затова горният запис няма ред cli, докато страницата за статично предварително генериране управлява цялото семейство команди за предварително генериране.

Редовете с идентификатори правят индекса полезен за търсене. Агент, който търси hook, изпълняван преди визуализирането на блок, преглежда редовете с hook-ове и стига до PHP Hooks, където е пълният речник на филтрите и действията. Агент, който търси статично предварително визуализиране, търси същата дума и стига до Static Prerendering и Settings, където съответно са описани броячите и конфигурацията. Петте публични схеми JSON са изброени по същия начин, заедно с маршрута и файла си.

Идентификаторите се извличат от проза, вграден код и примери с код. Блоковете, отбелязани с text, съдържат буквален изход и списъци с директории и се пропускат: документ, който показва изхода на команда, така не управлява тази команда.

Пълният текст

blockstudio-llm-full.txt е пълната документация и всички схеми в един файл. Той продължава да се генерира, публикува и адресира, но вече не е първото, което се предоставя на агента, и това е посочено в собствената му заглавна част.

Как се създават

Двата файла се сглобяват по време на компилация от npm run build:llm, който изпълнява scripts/build-llm.ts. Скриптът:

  1. Чете frontmatter на всеки публикуван документ в колекциите docs, guides и registry, за да извлече заглавието, маршрута и предназначението.
  2. Извлича идентификаторите, управлявани от всеки документ, от основното му съдържание: имената на куки от извиквания на филтри и действия, пътища към настройки, валидирани спрямо схемата на настройките, функции и класове на PHP, както и команди на CLI.
  3. Записва индекса в includes/llm/blockstudio-llm.txt.
  4. Обхожда дървото на документацията в реда на навигацията, премахва навигационните Markdown, като запазва заглавията и примерите с код, добавя схемите JSON и записва пълния текст в includes/llm/blockstudio-llm-full.txt.

npm run docs:check се проваля, ако публикуван документ липсва в индекса или ако индексът сочи към файл, който вече не съществува.

Как да ги използвате

  1. Активирайте настройката ai/enableContextGeneration във вашия blockstudio.json:
JSON
{
  "ai": {
    "enableContextGeneration": true
  }
}
  1. Файловете вече са достъпни на адрес your-site.com/blockstudio-llm.txt и your-site.com/blockstudio-llm-full.txt.

  2. Насочете своя инструмент с ИИ към индекса:

    • Cursor: добавете URL като документ в настройките на проекта си.
    • Claude Code: посочете URL или изтеглете файла и го добавете към контекста на проекта си.
    • GitHub Copilot: включете файла в хранилището си или го посочете в инструкциите си.

Ще работи всеки инструмент, който приема URL или текстов файл като контекст. И двата файла са статични и не включват данни за конкретния сайт, като например регистрираните от вас блокове или текущите настройки.

Собствен договор на проекта ви

Индексът описва Blockstudio. Той не описва проекта ви, а това е другата половина от необходимото на агента: къде се намират блоковете и страниците, кои функции са активирани и какъв анализ ще доведе до отхвърляне. vendor/bin/blockstudio-agents генерира тази информация от вашия blockstudio.json и собствените ви файлове. Вижте договора на проекта.