AI-integration
Blockstudio levereras med två kontextfiler för kodningsassistenter. Den första är ett kompakt index över dokumentationen. Den andra innehåller den fullständiga texten för alla dokument och scheman, för verktyg som vill hämta hela korpusen i en enda begäran.
En agent läser indexet, hittar dokumentet den behöver och öppnar det. Alternativet är att ge en agent en halv megabyte osorterad text, där inget går att hitta direkt och allt laddas oavsett om det är relevant eller inte.
Indexet
blockstudio-llm.txt listar varje publicerat dokument en gång, grupperat efter avsnitt och underavsnitt och i navigeringsordning. Varje post innehåller:
route: dokumentationens URL.file: Markdown-källsökvägen i Blockstudio-kodförrådet.purpose: en rad som beskriver dokumentets syfte.settings: de sökvägar förblockstudio.jsonsom dokumentet ansvarar för.hooks: namnen på de PHP- och JavaScript-filter och åtgärder som dokumentet ansvarar för.php: funktioner, klasser och metoder som dokumentet ansvarar för.cli: kommandon som dokumentet ansvarar för.
## 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()
En identifierarrad skrivs bara när dokumentet faktiskt ansvarar för något av den typen, så posten ovan saknar en cli-rad, medan sidan för statisk förhandsrendering ansvarar för hela familjen av förhandsrenderingskommandon.
Identifierarraderna gör indexet sökbart. En agent som letar efter den hook som körs före rendering av ett block söker bland hookraderna och hittar PHP Hooks, som ansvarar för hela uppsättningen filter och åtgärder. En agent som letar efter statisk förhandsrendering söker efter samma ord och hittar Statisk förhandsrendering och Inställningar, som ansvarar för räknarna respektive konfigurationen. De fem offentliga schemana för JSON listas på samma sätt, med sin sökväg och fil.
Identifierare läses från löptext, inline-kod och kodexempel. Kodblock markerade med text innehåller ordagrann utdata och kataloglistningar och hoppas därför över: ett dokument som visar utdata från ett kommando ansvarar inte därmed för kommandot.
Hela texten
blockstudio-llm-full.txt är den fullständiga dokumentationen och alla scheman i en enda fil. Den genereras fortfarande, publiceras fortfarande och går fortfarande att adressera, men är inte längre det en agent får först, vilket också framgår av dess egen rubrik.
Så byggs de
Båda filerna sammanställs vid byggtillfället av npm run build:llm, som kör scripts/build-llm.ts. Skriptet:
- Läser ingressinformationen för varje publicerat dokument i samlingarna
docs,guidesochregistryför att hämta titel, sökväg och syfte. - Hämtar identifierarna som varje dokument ansvarar för från dess egen brödtext: hooknamn från filter- och åtgärdsanrop, inställningssökvägar som validerats mot inställningsschemat, funktioner och klasser för PHP samt kommandon för CLI.
- Skriver indexet till
includes/llm/blockstudio-llm.txt. - Går igenom dokumentationsträdet i navigeringsordning, tar bort navigeringsspecifik Markdown samtidigt som rubriker och kodexempel bevaras, lägger till schemana för JSON och skriver hela texten till
includes/llm/blockstudio-llm-full.txt.
npm run docs:check misslyckas om ett publicerat dokument saknas i indexet eller om indexet pekar på en fil som inte längre finns.
Så använder du dem
- Aktivera inställningen
ai/enableContextGenerationi dinblockstudio.json:
{
"ai": {
"enableContextGeneration": true
}
}
-
Filerna finns nu på
your-site.com/blockstudio-llm.txtochyour-site.com/blockstudio-llm-full.txt. -
Peka ditt AI-verktyg på indexet:
- Cursor: lägg till URL som ett dokument i projektinställningarna.
- Claude Code: hänvisa till URL eller ladda ned filen och lägg till den i projektets kontext.
- GitHub Copilot: inkludera filen i kodförrådet eller hänvisa till den i instruktionerna.
Alla verktyg som godtar en URL- eller textfil som kontext fungerar. Båda filerna är statiska och innehåller inte webbplatsspecifika data som dina registrerade block eller aktuella inställningar.
Ditt projekts eget kontrakt
Indexet beskriver Blockstudio. Det beskriver inte ditt projekt, som är den andra halvan av det en agent behöver: var block och sidor finns, vilka funktioner som är aktiverade och vad analysen kommer att underkänna. vendor/bin/blockstudio-agents genererar den informationen från din blockstudio.json och dina egna filer. Se projektkontraktet.