AI-integration
Blockstudio leveres med to kontekstfiler til kodeassistenter. Den primære er et kompakt indeks over dokumentationen. Den anden indeholder den fulde tekst af hvert dokument og skema til værktøjer, der vil have hele samlingen i én forespørgsel.
En agent læser indekset, finder det ene dokument, den har brug for, og åbner det. Alternativet er at give agenten en halv megabyte usorteret tekst, hvor intet kan findes direkte, og alt indlæses, uanset om det er relevant eller ej.
Indekset
blockstudio-llm.txt oplister hvert offentliggjort dokument én gang, grupperet efter det afsnit og underafsnit, det tilhører, i navigationsrækkefølge. Hvert opslag indeholder:
route: dokumentationens URL.file: Markdown-kildestien i Blockstudio-arkivet.purpose: én linje, der beskriver dokumentets formål.settings: deblockstudio.json-stier, som dokumentet ejer.hooks: navnene på PHP- og JavaScript-filtre og -handlinger, som dokumentet ejer.php: de funktioner, klasser og metoder, som dokumentet ejer.cli: de kommandoer, som dokumentet ejer.
## 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 identifikatorlinje skrives kun, når dokumentet faktisk ejer noget af den pågældende type. Derfor har opslaget ovenfor ingen linje for cli, mens siden om statisk forhåndsgengivelse ejer hele familien af forhåndsgengivelseskommandoer.
Identifikatorlinjerne gør indekset søgbart. En agent, der leder efter hooket, som udløses før en blok gengives, søger i hooklinjerne og finder PHP Hooks, som ejer hele ordforrådet af filtre og handlinger. En agent, der leder efter statisk forhåndsgengivelse, søger på det samme ord og finder Statisk forhåndsgengivelse og Indstillinger, som ejer henholdsvis tællerne og konfigurationen. De fem offentlige JSON-skemaer er opført på samme måde med deres rute og fil.
Identifikatorer læses fra brødtekst, kode indlejret i teksten og kodeeksempler. Blokke markeret med text indeholder bogstaveligt output og mappelister og springes derfor over: Et dokument, der viser output fra en kommando, ejer ikke dermed kommandoen.
Den fulde tekst
blockstudio-llm-full.txt er den komplette dokumentation og alle skemaer samlet i én fil. Den genereres stadig, offentliggøres stadig og kan stadig adresseres, men den er ikke længere det første, en agent får udleveret, og det fremgår af dens egen indledning.
Sådan bygges filerne
Begge filer sammensættes ved byggetidspunktet af npm run build:llm, som kører scripts/build-llm.ts. Scriptet:
- Læser frontmatter fra hvert offentliggjort dokument i samlingerne
docs,guidesogregistryfor at hente titel, rute og formål. - Udtrækker de identifikatorer, som hvert dokument ejer, fra dets egen brødtekst: hooknavne fra filter- og handlingskald, indstillingsstier valideret mod indstillingsskemaet, PHP-funktioner og -klasser samt CLI-kommandoer.
- Skriver indekset til
includes/llm/blockstudio-llm.txt. - Går gennem dokumentationstræet i navigationsrækkefølge, fjerner Markdown, der kun bruges til navigation, bevarer overskrifter og kodeeksempler, tilføjer skemaerne JSON og skriver den fulde tekst til
includes/llm/blockstudio-llm-full.txt.
npm run docs:check fejler, hvis et offentliggjort dokument mangler i indekset, eller hvis indekset peger på en fil, der ikke længere findes.
Sådan bruger du dem
- Aktivér indstillingen
ai/enableContextGenerationi dinblockstudio.json:
{
"ai": {
"enableContextGeneration": true
}
}
-
Filerne er nu tilgængelige på
your-site.com/blockstudio-llm.txtogyour-site.com/blockstudio-llm-full.txt. -
Ret dit AI-værktøj mod indekset:
- Cursor: Tilføj URL som dokumentation i projektindstillingerne.
- Claude Code: Henvis til URL, eller download filen, og tilføj den til projektets kontekst.
- GitHub Copilot: Medtag filen i dit arkiv, eller henvis til den i dine instruktioner.
Alle værktøjer, der accepterer en URL eller en tekstfil som kontekst, kan bruges. Begge filer er statiske og indeholder ikke stedspecifikke data som dine registrerede blokke eller aktuelle indstillinger.
Dit projekts egen kontrakt
Indekset beskriver Blockstudio. Det beskriver ikke dit projekt, som er den anden halvdel af det, en agent har brug for: hvor blokke og sider findes, hvilke funktioner der er aktiveret, og hvad analysen vil afvise. vendor/bin/blockstudio-agents genererer den ud fra din blockstudio.json og dine egne filer. Se projektkontrakten.