AI-integráció
A Blockstudio két kontextusfájlt biztosít a kódolást segítő asszisztenseknek. Az első a dokumentáció tömör indexe. A második minden dokumentum és séma teljes szövegét tartalmazza azoknak az eszközöknek, amelyek egyetlen kérésben szeretnék megkapni a teljes korpuszt.
Az ügynök beolvassa az indexet, megkeresi a szükséges dokumentumot, majd megnyitja azt. Másik lehetőségként fél megabájtnyi, tagolatlan prózát is átadhatunk neki, amelyben semmi sem címezhető, és minden tartalom betöltődik, függetlenül attól, hogy releváns-e.
Az index
A blockstudio-llm.txt minden közzétett dokumentumot egyszer sorol fel, az őt tartalmazó szakasz és alszakasz szerint csoportosítva, a navigáció sorrendjében. Minden bejegyzés tartalmazza a következőket:
route: a dokumentáció URL.file: a Blockstudio adattárban lévő Markdown forrás elérési útja.purpose: egy sor arról, mire szolgál a dokumentum.settings: a dokumentumhoz tartozóblockstudio.jsonútvonalak.hooks: a hozzá tartozó PHP- és JavaScript-szűrők, valamint műveletnevek.php: a hozzá tartozó függvények, osztályok és metódusok.cli: a hozzá tartozó parancsok.
## 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()
Az azonosítósor csak akkor jelenik meg, ha a dokumentum ténylegesen birtokol valamit az adott típusból. Ezért a fenti bejegyzésben nincs cli sor, míg a statikus előrenderelési oldal a teljes előrenderelési parancscsaládhoz tartozik.
Az azonosítósorok teszik megválaszolhatóvá az indexet. Ha egy ügynök azt a hookot keresi, amely egy blokk renderelése előtt fut le, átnézi a hook sorokat, és a PHP Hooks oldalra jut, amely az összes szűrő- és műveletnevet tartalmazza. Ha statikus előrenderelést keres, ugyanerre a kifejezésre keresve a Statikus előrenderelés és a Beállítások oldalra jut, amelyek rendre a számlálókat és a konfigurációt tartalmazzák. Az öt nyilvános JSON séma ugyanígy szerepel, az útvonalukkal és a fájljukkal együtt.
Az azonosítókat prózából, beágyazott kódból és kódpéldákból olvassa ki a rendszer. A text jelölésű blokkok szó szerinti kimenetet és könyvtárlistákat tartalmaznak, ezért kimaradnak: egy parancs kimenetét megjelenítő dokumentum ettől még nem birtokolja az adott parancsot.
A teljes szöveg
A blockstudio-llm-full.txt egyetlen fájlban tartalmazza a teljes dokumentációt és az összes sémát. Továbbra is generált, közzétett és címezhető, de már nem ezt kapja meg elsőként az ügynök, és ezt a saját fejlécében is jelzi.
Hogyan készülnek
Mindkét fájlt a npm run build:llm állítja össze buildidőben, és a scripts/build-llm.ts futtatásával. A parancsfájl:
- Kiolvassa minden közzétett dokumentum fejlécadataiból a címet, az útvonalat és a rendeltetést a
docs,guidesésregistrygyűjteményekben. - Kinyeri a dokumentum saját törzsszövegéből a hozzá tartozó azonosítókat: a szűrő- és művelethívásokból a hookneveket, a beállítási sémával ellenőrzött beállítási útvonalakat, a PHP függvényeit és osztályait, valamint a CLI parancsait.
- Kiírja az indexet a
includes/llm/blockstudio-llm.txtfájlba. - A dokumentációs fán a navigáció sorrendjében halad végig, eltávolítja a csak navigációhoz szükséges Markdown elemeket, miközben megőrzi a címsorokat és kódpéldákat, hozzáfűzi a JSON sémákat, majd a teljes szöveget a
includes/llm/blockstudio-llm-full.txtfájlba írja.
A npm run docs:check hibát jelez, ha egy közzétett dokumentum hiányzik az indexből, vagy ha az index olyan fájlra hivatkozik, amely már nem létezik.
Használat
- Engedélyezze a
ai/enableContextGenerationbeállítást ablockstudio.jsonfájlban:
{
"ai": {
"enableContextGeneration": true
}
}
-
A fájlok mostantól itt érhetők el:
your-site.com/blockstudio-llm.txtésyour-site.com/blockstudio-llm-full.txt. -
Irányítsa a mesterségesintelligencia-eszközt az indexre:
- Cursor: adja hozzá a URL elemet dokumentumként a projektbeállításokban.
- Claude Code: hivatkozzon a URL elemre, vagy töltse le a fájlt, és adja hozzá a projektkontextushoz.
- GitHub Copilot: vegye fel a fájlt az adattárba, vagy hivatkozzon rá az utasításaiban.
Bármely eszköz használható, amely elfogad URL vagy szövegfájlt kontextusként. Mindkét fájl statikus, és nem tartalmaz webhelyspecifikus adatokat, például a regisztrált blokkokat vagy az aktuális beállításokat.
A projekt saját szerződésleírása
Az index a Blockstudio írja le. A projektedről nem ad leírást, pedig az is szükséges az ügynöknek: hol találhatók a blokkok és oldalak, mely funkciók vannak engedélyezve, és milyen elemzési hibák utasítják el a projektet. A vendor/bin/blockstudio-agents ezt a blockstudio.json és a saját fájljaid alapján állítja elő. Lásd a projekt szerződésleírását.