İçeriğe geç

AI Entegrasyonu

Blockstudio, kodlama asistanları için iki bağlam dosyası sunar. İlki, belgelerin kısa bir dizinidir. İkincisi, tek istekte tüm belge ve şemaların tam metnini isteyen araçlar için bunların tamamını içerir.

Bir ajan dizini okur, ihtiyaç duyduğu belgeyi bulur ve onu açar. Diğer seçenek, bir ajana adreslenebilir hiçbir şeyin olmadığı ve ilgili olup olmadığına bakılmaksızın her şeyin yüklendiği, yarım megabaytlık ayrıştırılmamış metin vermektir.

Dizin

blockstudio-llm.txt, yayımlanmış her belgeyi bir kez; ait olduğu bölüm ve alt bölüme göre, gezinme sırasıyla listeler. Her giriş şunları içerir:

  • route: belgelerin URL.
  • file: Blockstudio deposundaki Markdown kaynak yolu.
  • purpose: belgenin amacını açıklayan tek satır.
  • settings: belgenin sahip olduğu blockstudio.json yolları.
  • hooks: belgenin sahip olduğu PHP ve JavaScript filtre ve eylem adları.
  • php: belgenin sahip olduğu işlevler, sınıflar ve yöntemler.
  • cli: belgenin sahip olduğu komutlar.
Text
## 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()

Bir tanımlayıcı satırı yalnızca belge ilgili türde gerçekten bir şeye sahipse yazılır. Bu nedenle yukarıdaki girişte cli satırı yoktur; statik önceden oluşturma sayfası ise önceden oluşturma komut ailesinin tamamına sahiptir.

Dizin sayesinde tanımlayıcı satırlarıyla arama yapılabilir. Bir bloğun işlenmesinden önce çalışan kancayı arayan ajan, kanca satırlarını tarayıp tüm filtre ve eylem adlarına sahip olan PHP Kancalar belgesine ulaşır. Statik önceden oluşturmayı arayan ajan aynı sözcüğü tarayıp sırasıyla sayaçlara ve yapılandırmaya sahip olan Statik Önceden Oluşturma ve Ayarlar belgelerine ulaşır. Beş genel JSON şema da aynı şekilde, rotaları ve dosyalarıyla listelenir.

Tanımlayıcılar düzyazıdan, satır içi koddan ve kod örneklerinden okunur. text ile işaretlenmiş bloklarda değişmez çıktı ve dizin listeleri bulunur; bu nedenle bunlar atlanır: bir komutun çıktısını yazdıran belge, bu yüzden o komuta sahip sayılmaz.

Tam metin

blockstudio-llm-full.txt, tüm belgelerin ve her şemanın tek dosyadaki tam metnidir. Hâlâ oluşturulur, yayımlanır ve adreslenebilir; ancak artık ajana ilk verilen içerik değildir ve kendi başlığında da bu belirtilir.

Nasıl oluşturulurlar

Her iki dosya da derleme sırasında npm run build:llm tarafından oluşturulur; bu işlem scripts/build-llm.ts komutunu çalıştırır. Betik:

  1. Başlık, rota ve amaç bilgilerini almak için docs, guides ve registry koleksiyonlarındaki yayımlanmış her belgenin ön bilgisini okur.
  2. Her belgenin kendi gövdesinden sahip olduğu tanımlayıcıları çıkarır: filtre ve eylem çağrılarındaki kanca adları, ayarlar şemasına göre doğrulanan ayar yolları, PHP işlevleri ve sınıfları, ayrıca CLI komutları.
  3. Dizini includes/llm/blockstudio-llm.txt konumuna yazar.
  4. Belge ağacında gezinme sırasıyla ilerler, başlıkları ve kod örneklerini koruyarak yalnızca gezinme amaçlı Markdown öğelerini kaldırır, JSON şemalarını ekler ve tam metni includes/llm/blockstudio-llm-full.txt konumuna yazar.

Yayımlanmış bir belge dizinde eksikse veya dizin artık mevcut olmayan bir dosyaya işaret ediyorsa npm run docs:check başarısız olur.

Nasıl kullanılırlar

  1. blockstudio.json içinde ai/enableContextGeneration ayarını etkinleştirin:
JSON
{
  "ai": {
    "enableContextGeneration": true
  }
}
  1. Dosyalar artık your-site.com/blockstudio-llm.txt ve your-site.com/blockstudio-llm-full.txt konumlarında kullanılabilir.

  2. AI aracınızı dizine yönlendirin:

    • Cursor: URL belgesini proje ayarlarınızda belge olarak ekleyin.
    • Claude Code: URL öğesine başvurun veya dosyayı indirip proje bağlamınıza ekleyin.
    • GitHub Copilot: dosyayı deponuza ekleyin veya talimatlarınızda ona başvurun.

Bağlam olarak bir URL veya metin dosyası kabul eden tüm araçlar çalışır. Her iki dosya da statiktir ve kayıtlı bloklarınız ya da geçerli ayarlarınız gibi siteye özgü verileri içermez.

Projenizin kendi sözleşmesi

Dizin, Blockstudio öğesini açıklar. Ajanın ihtiyaç duyduğu diğer yarıyı, yani blok ve sayfaların konumlarını, hangi özelliklerin etkin olduğunu ve hangi analizlerin reddedileceğini açıklamaz. vendor/bin/blockstudio-agents bunu blockstudio.json ve kendi dosyalarınızdan oluşturur. proje sözleşmesine bakın.