Integrare AI
Blockstudio include două fișiere de context pentru asistenții de programare. Primul este un index compact al documentației. Al doilea conține textul integral al fiecărui document și al fiecărei scheme, pentru instrumentele care vor întregul corpus într-o singură solicitare.
Un agent citește indexul, găsește documentul de care are nevoie și îl deschide. Alternativa este să îi furnizați unui agent jumătate de megabyte de proză fără structură, în care nimic nu poate fi adresat și totul se încarcă indiferent dacă este relevant sau nu.
Indexul
blockstudio-llm.txt enumeră o singură dată fiecare document publicat, grupat după secțiunea și subsecțiunea din care face parte, în ordinea navigării. Fiecare intrare conține:
route: URL documentației.file: calea sursă Markdown din depozitul Blockstudio.purpose: o linie care descrie scopul documentului.settings: căileblockstudio.jsonpe care le gestionează documentul.hooks: numele filtrelor și acțiunilor PHP și JavaScript pe care le gestionează.php: funcțiile, clasele și metodele pe care le gestionează.cli: comenzile pe care le gestionează.
## 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()
O linie de identificatori este scrisă numai când documentul gestionează efectiv ceva de acel tip, așa că intrarea de mai sus nu are o linie cli, în timp ce pagina de prerandare statică gestionează întreaga familie de comenzi de prerandare.
Liniile de identificatori fac indexul interogabil. Un agent care caută cârligul care se declanșează înainte de randarea unui bloc parcurge liniile de cârlige și ajunge la PHP Hooks, care include vocabularul complet de filtre și acțiuni. Un agent care caută prerandarea statică caută același cuvânt și ajunge la Static Prerendering și Settings, care gestionează, respectiv, contoarele și configurarea. Cele cinci scheme publice JSON sunt listate la fel, împreună cu ruta și fișierul lor.
Identificatorii sunt citiți din proză, cod inline și exemple de cod. Blocurile marcate cu text conțin ieșire literală și listări de directoare, așa că sunt ignorate: un document care afișează ieșirea unei comenzi nu ajunge astfel să gestioneze comanda respectivă.
Textul integral
blockstudio-llm-full.txt conține documentația completă și fiecare schemă într-un singur fișier. Este în continuare generat, publicat și adresabil, dar nu mai este primul lucru oferit unui agent, iar antetul propriu precizează acest lucru.
Cum sunt construite
Ambele fișiere sunt asamblate în timpul compilării de către npm run build:llm, care execută scripts/build-llm.ts. Scriptul:
- Citește frontmatter-ul fiecărui document publicat din colecțiile
docs,guidesșiregistrypentru titlu, rută și scop. - Extrage identificatorii gestionați de fiecare document din propriul corp: nume de cârlige din apelurile de filtre și acțiuni, căi de setări validate conform schemei de setări, funcții și clase PHP și comenzi CLI.
- Scrie indexul în
includes/llm/blockstudio-llm.txt. - Parcurge arborele documentației în ordinea navigării, elimină Markdown folosite doar pentru navigare, păstrând titlurile și exemplele de cod, adaugă schemele JSON și scrie textul integral în
includes/llm/blockstudio-llm-full.txt.
npm run docs:check eșuează dacă lipsește din index un document publicat sau dacă indexul indică un fișier care nu mai există.
Cum se folosesc
- Activați setarea
ai/enableContextGenerationînblockstudio.json:
{
"ai": {
"enableContextGeneration": true
}
}
-
Fișierele sunt acum disponibile la
your-site.com/blockstudio-llm.txtșiyour-site.com/blockstudio-llm-full.txt. -
Indicați instrumentului AI indexul:
- Cursor: adăugați URL ca document în setările proiectului.
- Claude Code: menționați URL sau descărcați fișierul și adăugați-l la contextul proiectului.
- GitHub Copilot: includeți fișierul în depozit sau menționați-l în instrucțiuni.
Va funcționa orice instrument care acceptă un URL sau un fișier text ca context. Ambele fișiere sunt statice și nu includ date specifice site-ului, cum ar fi blocurile înregistrate sau setările curente.
Contractul propriului proiect
Indexul descrie Blockstudio. Nu descrie proiectul dumneavoastră, cealaltă parte de care are nevoie un agent: unde se află blocurile și paginile, ce funcționalități sunt activate și ce va respinge analiza. vendor/bin/blockstudio-agents generează aceste informații din blockstudio.json și din fișierele proprii. Consultați contractul proiectului.