Integracja AI
Blockstudio udostępnia dwa pliki kontekstowe dla asystentów programowania. Pierwszy to zwięzły indeks dokumentacji. Drugi zawiera pełny tekst każdego dokumentu i schematu — dla narzędzi, które chcą otrzymać cały zbiór w jednym żądaniu.
Agent odczytuje indeks, znajduje potrzebny dokument i otwiera go. Alternatywą jest przekazanie agentowi pół megabajta nieuporządkowanego tekstu, w którym niczego nie da się wskazać, a ładowane jest wszystko, niezależnie od tego, czy ma to znaczenie.
Indeks
blockstudio-llm.txt wymienia każdy opublikowany dokument dokładnie raz, pogrupowany według sekcji i podsekcji, do których należy, w kolejności nawigacji. Każdy wpis zawiera:
route: dokumentacji URL.file: ścieżkę źródłową Markdown w repozytorium Blockstudio.purpose: jednozdaniowy opis przeznaczenia dokumentu.settings: ścieżkiblockstudio.json, za które odpowiada dokument.hooks: nazwy filtrów i akcji PHP oraz JavaScript, za które odpowiada dokument.php: funkcje, klasy i metody, za które odpowiada dokument.cli: polecenia, za które odpowiada dokument.
## 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()
Wiersz identyfikatora jest zapisywany tylko wtedy, gdy dokument faktycznie obejmuje coś danego rodzaju. Dlatego powyższy wpis nie ma wiersza cli, podczas gdy strona statycznego wstępnego renderowania obejmuje całą rodzinę poleceń do prerenderowania.
To wiersze identyfikatorów sprawiają, że można wyszukiwać w indeksie. Agent szukający hooka uruchamianego przed renderowaniem bloku przegląda wiersze hooków i trafia na PHP Hooki, który obejmuje pełny zestaw filtrów i akcji. Agent szukający statycznego wstępnego renderowania wyszukuje to samo hasło i trafia na Statyczne wstępne renderowanie oraz Ustawienia, które odpowiadają odpowiednio za liczniki i konfigurację. Pięć publicznych schematów JSON jest wymienionych w ten sam sposób, wraz ze swoją ścieżką i plikiem.
Identyfikatory są odczytywane z tekstu, kodu w wierszu i przykładów kodu. Bloki oznaczone jako text zawierają dosłowne wyniki i wykazy katalogów, dlatego są pomijane: dokument wyświetlający wynik polecenia nie staje się przez to właścicielem tego polecenia.
Pełny tekst
blockstudio-llm-full.txt to jeden plik zawierający pełną dokumentację i wszystkie schematy. Nadal jest generowany, publikowany i adresowalny, ale agent nie otrzymuje go już jako pierwszego pliku; informuje o tym jego własny nagłówek.
Jak powstają
Oba pliki są składane podczas kompilacji przez npm run build:llm, który uruchamia scripts/build-llm.ts. Skrypt:
- Odczytuje nagłówki frontmatter każdego opublikowanego dokumentu w zbiorach
docs,guidesiregistry, aby pobrać jego tytuł, ścieżkę i przeznaczenie. - Wyodrębnia z treści identyfikatory, za które odpowiada każdy dokument: nazwy hooków z wywołań filtrów i akcji, ścieżki ustawień zweryfikowane względem schematu ustawień, funkcje i klasy PHP oraz polecenia CLI.
- Zapisuje indeks w
includes/llm/blockstudio-llm.txt. - Przechodzi przez drzewo dokumentacji w kolejności nawigacji, usuwa elementy Markdown służące wyłącznie nawigacji, zachowując nagłówki i przykłady kodu, dołącza schematy JSON i zapisuje pełny tekst w
includes/llm/blockstudio-llm-full.txt.
npm run docs:check kończy działanie błędem, gdy opublikowanego dokumentu brakuje w indeksie lub gdy indeks wskazuje na plik, który już nie istnieje.
Jak ich używać
- Włącz ustawienie
ai/enableContextGenerationw swoimblockstudio.json:
{
"ai": {
"enableContextGeneration": true
}
}
-
Pliki są teraz dostępne pod adresami
your-site.com/blockstudio-llm.txtiyour-site.com/blockstudio-llm-full.txt. -
Skieruj swoje narzędzie AI do indeksu:
- Cursor: dodaj URL jako dokument w ustawieniach projektu.
- Claude Code: wskaż URL albo pobierz plik i dodaj go do kontekstu projektu.
- GitHub Copilot: dołącz plik do repozytorium lub wskaż go w instrukcjach.
Zadziała każde narzędzie, które przyjmuje URL lub plik tekstowy jako kontekst. Oba pliki są statyczne i nie zawierają danych specyficznych dla witryny, takich jak zarejestrowane bloki czy bieżące ustawienia.
Własny kontrakt projektu
Indeks opisuje Blockstudio. Nie opisuje jednak projektu, a agent potrzebuje także tych informacji: gdzie znajdują się bloki i strony, które funkcje są włączone i co zostanie odrzucone podczas analizy. vendor/bin/blockstudio-agents generuje te dane na podstawie blockstudio.json i własnych plików projektu. Zobacz kontrakt projektu.