AI-integratie
Blockstudio levert twee contextbestanden voor codeerassistenten. Het belangrijkste is een beknopte index van de documentatie. Het tweede bevat de volledige tekst van elk document en schema, voor tools die het hele corpus in één verzoek willen hebben.
Een agent leest de index, vindt het benodigde document en opent het. Het alternatief is een agent een halve megabyte ongedifferentieerde tekst aanreiken, waarin niets afzonderlijk vindbaar is en alles wordt geladen, ongeacht of het relevant is.
De index
blockstudio-llm.txt vermeldt elk gepubliceerd document één keer, gegroepeerd op de sectie en subsectie waartoe het behoort, in navigatievolgorde. Elke vermelding bevat:
route: de URL van de documentatie.file: het bronpad Markdown in de repository Blockstudio.purpose: één regel die beschrijft waarvoor het document dient.settings: deblockstudio.json-paden die bij dat document horen.hooks: de filter- en actienamen PHP en JavaScript die bij dat document horen.php: de functies, klassen en methoden die bij dat document horen.cli: de opdrachten die bij dat document horen.
## 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()
Een identificatieregel wordt alleen opgenomen wanneer het document daadwerkelijk iets van dat type bevat. Daarom heeft de bovenstaande vermelding geen regel voor cli, terwijl de pagina voor statische prerendering de volledige familie prerenderopdrachten bevat.
De identificatieregels maken de index doorzoekbaar. Een agent die zoekt naar de hook die wordt uitgevoerd voordat een blok wordt weergegeven, doorzoekt de hookregels en komt uit bij PHP Hooks, waar de volledige filter- en actiewoordenschat is vastgelegd. Een agent die statische prerendering zoekt, zoekt op hetzelfde woord en komt uit bij Statische prerendering en Instellingen, waar respectievelijk de tellers en configuratie zijn vastgelegd. De vijf openbare JSON-schema’s worden op dezelfde manier vermeld, samen met hun route en bestand.
Identificaties worden uit proza, inline code en codevoorbeelden gelezen. Blokken met de aanduiding text bevatten letterlijke uitvoer en directoryvermeldingen en worden daarom overgeslagen: een document dat de uitvoer van een opdracht toont, hoort die opdracht daardoor nog niet toe.
De volledige tekst
blockstudio-llm-full.txt bevat de volledige documentatie en elk schema in één bestand. Het wordt nog steeds gegenereerd, gepubliceerd en is doorzoekbaar, maar een agent krijgt het niet meer als eerste aangereikt; dat staat ook in de eigen koptekst.
Hoe ze worden samengesteld
Beide bestanden worden tijdens het bouwen samengesteld door npm run build:llm, dat scripts/build-llm.ts uitvoert. Het script:
- Leest de frontmatter van elk gepubliceerd document in de collecties
docs,guidesenregistryvoor de titel, route en het doel. - Haalt de identificaties die elk document bevat uit de hoofdtekst: hooknamen uit filter- en aanroepingen van acties, instellingenpaden gevalideerd tegen het instellingenschema, functies en klassen van PHP en opdrachten van CLI.
- Schrijft de index naar
includes/llm/blockstudio-llm.txt. - Doorloopt de documentatiestructuur in navigatievolgorde, verwijdert alleen voor navigatie bedoelde Markdown met behoud van koppen en codevoorbeelden, voegt de schema’s JSON toe en schrijft de volledige tekst naar
includes/llm/blockstudio-llm-full.txt.
npm run docs:check mislukt wanneer een gepubliceerd document ontbreekt in de index of wanneer de index verwijst naar een bestand dat niet meer bestaat.
Hoe je ze gebruikt
- Schakel de instelling
ai/enableContextGenerationin jeblockstudio.jsonin:
{
"ai": {
"enableContextGeneration": true
}
}
-
De bestanden zijn nu beschikbaar op
your-site.com/blockstudio-llm.txtenyour-site.com/blockstudio-llm-full.txt. -
Verwijs je AI-tool naar de index:
- Cursor: voeg de URL als document toe aan de projectinstellingen.
- Claude Code: verwijs naar de URL of download het bestand en voeg het toe aan de projectcontext.
- GitHub Copilot: neem het bestand op in je repository of verwijs ernaar in je instructies.
Elke tool die een URL- of tekstbestand als context accepteert, werkt. Beide bestanden zijn statisch en bevatten geen sitespecifieke gegevens, zoals je geregistreerde blokken of huidige instellingen.
Het contract van je project
De index beschrijft Blockstudio. Hij beschrijft je project niet, terwijl dat de andere helft is van wat een agent nodig heeft: waar blokken en pagina’s staan, welke functies zijn ingeschakeld en wat de analyse afkeurt. vendor/bin/blockstudio-agents genereert dat op basis van je blockstudio.json en je eigen bestanden. Zie het projectcontract.