Integrasi AI
Blockstudio menyediakan dua file konteks untuk asisten pemrograman. File utama adalah indeks dokumentasi ringkas. File kedua berisi teks lengkap setiap dokumen dan skema, untuk alat yang membutuhkan seluruh korpus dalam satu permintaan.
Agen membaca indeks, menemukan dokumen yang dibutuhkan, lalu membukanya. Alternatifnya adalah memberikan setengah megabita prosa tanpa pembeda kepada agen, sehingga tidak ada bagian yang dapat dituju dan semuanya dimuat, baik relevan maupun tidak.
Indeks
blockstudio-llm.txt mencantumkan setiap dokumen yang diterbitkan satu kali, dikelompokkan berdasarkan bagian dan subbagian, sesuai urutan navigasi. Setiap entri memuat:
route: URL dokumentasi.file: jalur sumber Markdown di repositori Blockstudio.purpose: satu baris yang menjelaskan kegunaan dokumen.settings: jalurblockstudio.jsonyang dimiliki dokumen tersebut.hooks: nama filter dan aksi PHP serta JavaScript yang dimiliki dokumen tersebut.php: fungsi, kelas, dan metode yang dimilikinya.cli: perintah yang dimilikinya.
## 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()
Baris pengenal hanya ditulis ketika dokumen benar-benar memiliki sesuatu dari jenis tersebut. Karena itu, entri di atas tidak memiliki baris cli, sedangkan halaman prerendering statis memiliki seluruh rangkaian perintah prerender.
Baris pengenal membuat indeks dapat ditelusuri. Agen yang mencari hook yang dijalankan sebelum blok dirender dapat memindai baris hook dan menemukan Hook PHP, yang mencakup seluruh kosakata filter dan aksi. Agen yang mencari prerendering statis dapat mencari kata yang sama dan menemukan Prerendering Statis serta Pengaturan, yang masing-masing memiliki penghitung dan konfigurasi. Lima skema JSON publik dicantumkan dengan cara yang sama, beserta rute dan filenya.
Pengenal dibaca dari prosa, kode sebaris, dan contoh kode. Blok bertanda text berisi output literal dan daftar direktori, sehingga dilewati: dokumen yang mencetak output perintah tidak serta-merta memiliki perintah tersebut.
Teks lengkap
blockstudio-llm-full.txt adalah dokumentasi lengkap beserta setiap skema dalam satu file. File ini tetap dihasilkan, diterbitkan, dan dapat dituju, tetapi bukan lagi materi pertama yang diberikan kepada agen; hal itu dijelaskan di headernya sendiri.
Cara pembuatannya
Kedua file dirangkai pada waktu build oleh npm run build:llm, yang menjalankan scripts/build-llm.ts. Skrip tersebut:
- Membaca frontmatter setiap dokumen yang diterbitkan dalam koleksi
docs,guides, danregistryuntuk mengambil judul, rute, dan kegunaannya. - Mengekstrak pengenal yang dimiliki setiap dokumen dari isi dokumennya: nama hook dari pemanggilan filter dan aksi, jalur pengaturan yang divalidasi terhadap skema pengaturan, fungsi dan kelas PHP, serta perintah CLI.
- Menulis indeks ke
includes/llm/blockstudio-llm.txt. - Menelusuri pohon dokumentasi sesuai urutan navigasi, menghapus Markdown khusus navigasi dengan tetap mempertahankan judul dan contoh kode, menambahkan skema JSON, lalu menulis teks lengkap ke
includes/llm/blockstudio-llm-full.txt.
npm run docs:check gagal jika dokumen yang diterbitkan tidak ada dalam indeks, atau jika indeks menunjuk ke file yang sudah tidak ada.
Cara menggunakannya
- Aktifkan pengaturan
ai/enableContextGenerationdiblockstudio.jsonAnda:
{
"ai": {
"enableContextGeneration": true
}
}
-
File kini tersedia di
your-site.com/blockstudio-llm.txtdanyour-site.com/blockstudio-llm-full.txt. -
Arahkan alat AI Anda ke indeks:
- Cursor: tambahkan URL sebagai dokumen di pengaturan proyek Anda.
- Claude Code: rujuk URL atau unduh file dan tambahkan ke konteks proyek Anda.
- GitHub Copilot: sertakan file di repositori atau rujuk dalam instruksi Anda.
Alat apa pun yang menerima URL atau file teks sebagai konteks dapat digunakan. Kedua file bersifat statis dan tidak menyertakan data khusus situs seperti blok terdaftar atau pengaturan saat ini.
Kontrak proyek Anda sendiri
Indeks menjelaskan Blockstudio. Indeks tidak menjelaskan proyek Anda, padahal itu separuh informasi yang dibutuhkan agen: lokasi blok dan halaman, fitur yang diaktifkan, serta hal yang akan ditolak oleh analisis. vendor/bin/blockstudio-agents membuat kontrak tersebut dari blockstudio.json dan file Anda sendiri. Lihat kontrak proyek.