Integración con IA
Blockstudio incluye dos archivos de contexto para asistentes de programación. El primero es un índice compacto de la documentación. El segundo contiene el texto completo de cada documento y esquema, para las herramientas que quieren todo el corpus en una sola solicitud.
Un agente lee el índice, encuentra el documento que necesita y lo abre. La alternativa es entregarle medio megabyte de prosa sin clasificar, donde nada se puede consultar por separado y se carga todo, sea pertinente o no.
El índice
blockstudio-llm.txt enumera una vez cada documento publicado, agrupado por la
sección y subsección a las que pertenece, en el orden de navegación. Cada entrada incluye:
route: la URL de documentación.file: la ruta de origen Markdown en el repositorio Blockstudio.purpose: una línea que describe para qué sirve el documento.settings: las rutasblockstudio.jsonque pertenecen al documento.hooks: los nombres de filtros y acciones PHP y JavaScript que le pertenecen.php: las funciones, clases y métodos que le pertenecen.cli: los comandos que le pertenecen.
## 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()
La línea de un identificador solo se incluye cuando el documento realmente posee algo de
ese tipo, por lo que la entrada anterior no tiene una línea cli, mientras que la página de prerenderizado estático posee toda la familia de comandos de prerenderizado.
Las líneas de identificadores permiten consultar el índice. Un agente que busque el hook que se activa antes de renderizar un bloque revisa las líneas de hooks y llega a PHP Hooks, que contiene el vocabulario completo de filtros y acciones. Un agente que busque el prerenderizado estático busca la misma palabra y llega a Prerenderizado estático y Ajustes, que contienen los contadores y la configuración, respectivamente. Los cinco esquemas públicos de JSON se enumeran del mismo modo, con su ruta y su archivo.
Los identificadores se leen de la prosa, el código integrado y los ejemplos de código. Los bloques marcados
text contienen salida literal y listados de directorios, por lo que se omiten: un
documento que muestra la salida de un comando no pasa por ello a ser propietario de ese comando.
El texto completo
blockstudio-llm-full.txt es la documentación completa y todos los esquemas en un solo
archivo. Sigue generándose, publicándose y siendo consultable, pero ya no es lo
primero que se entrega a un agente, y así lo indica su propio encabezado.
Cómo se generan
Ambos archivos se ensamblan durante la compilación mediante npm run build:llm, que ejecuta
scripts/build-llm.ts. El script:
- Lee el frontmatter de cada documento publicado en las colecciones
docs,guidesyregistrypara obtener su título, ruta y propósito. - Extrae del cuerpo de cada documento los identificadores que posee: nombres de hooks de las llamadas a filtros y acciones, rutas de ajustes validadas contra el esquema de ajustes, funciones y clases de PHP, y comandos de CLI.
- Escribe el índice en
includes/llm/blockstudio-llm.txt. - Recorre el árbol de documentación en orden de navegación, elimina los elementos Markdown que solo sirven para la navegación, conservando los encabezados y ejemplos de código, añade los esquemas JSON
y escribe el texto completo en
includes/llm/blockstudio-llm-full.txt.
npm run docs:check falla si falta del índice un documento publicado
o si el índice apunta a un archivo que ya no existe.
Cómo usarlos
- Habilite el ajuste
ai/enableContextGenerationen sublockstudio.json:
{
"ai": {
"enableContextGeneration": true
}
}
-
Los archivos estarán disponibles en
your-site.com/blockstudio-llm.txtyyour-site.com/blockstudio-llm-full.txt. -
Indique a su herramienta de IA que use el índice:
- Cursor: añada el URL como documento en los ajustes del proyecto.
- Claude Code: haga referencia a URL o descargue el archivo y añádalo al contexto del proyecto.
- GitHub Copilot: incluya el archivo en el repositorio o haga referencia a él en sus instrucciones.
Cualquier herramienta que admita un URL o un archivo de texto como contexto funcionará. Ambos archivos son estáticos y no incluyen datos específicos del sitio, como los bloques registrados o los ajustes actuales.
El contrato propio de su proyecto
El índice describe Blockstudio. No describe su proyecto, que es la otra mitad de lo que necesita un agente: dónde están los bloques y las páginas, qué funciones están habilitadas y qué rechazará el análisis. vendor/bin/blockstudio-agents lo genera a partir de su blockstudio.json y sus propios archivos. Consulte el contrato del proyecto.