Siirry sisältöön

Tekoälyintegraatio

Blockstudio sisältää kaksi kontekstitiedostoa koodausavustajille. Ensimmäinen on tiivis dokumentaatiohakemisto. Toinen sisältää kaikkien dokumenttien ja skeemojen koko tekstin työkaluille, jotka haluavat koko aineiston yhdellä pyynnöllä.

Agentti lukee hakemiston, etsii tarvitsemansa dokumentin ja avaa sen. Vaihtoehtona olisi antaa agentille puoli megatavua erittelemätöntä tekstiä, jossa sisältöön ei voi viitata täsmällisesti ja kaikki ladataan riippumatta siitä, onko se olennaista.

Hakemisto

blockstudio-llm.txt luettelee jokaisen julkaistun dokumentin kerran ja ryhmittelee ne osioiden ja alaosioiden mukaan navigointijärjestyksessä. Jokaisessa kohdassa on:

  • route: dokumentaation URL.
  • file: Blockstudio-säilön Markdown-lähdepolku.
  • purpose: yhdellä rivillä kerrotaan dokumentin tarkoitus.
  • settings: dokumentin omistamat blockstudio.json-polut.
  • hooks: dokumentin omistamat PHP- ja JavaScript-suodatin- ja toimintokutsujen nimet.
  • php: dokumentin omistamat funktiot, luokat ja metodit.
  • cli: dokumentin omistamat komennot.
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()

Tunnisterivi kirjoitetaan vain, jos dokumentti todella omistaa jotakin kyseistä tyyppiä. Siksi yllä olevassa kohdassa ei ole cli-riviä, kun taas staattisen esirenderöinnin sivu omistaa koko esirenderöintikomentoperheen.

Tunnisterivien ansiosta hakemistosta voi etsiä vastauksia. Lohkon renderöintiä edeltävää hook-kutsua etsivä agentti selaa hook-rivejä ja löytää kohdan PHP Hooks, joka kattaa suodattimien ja toimintojen koko nimistön. Staattista esirenderöintiä etsivä agentti hakee samaa sanaa ja löytää kohdat Static Prerendering ja Settings, jotka kattavat vastaavasti laskurit ja määritykset. Kaikki viisi julkista JSON-skeemaa luetellaan samalla tavalla reitteineen ja tiedostoineen.

Tunnisteet luetaan proosasta, rivinsisäisestä koodista ja koodiesimerkeistä. Merkillä text merkityt lohkot sisältävät kirjaimellisia tulosteita ja hakemistolistauksia, joten ne ohitetaan: dokumentti ei omista komentoa vain siksi, että siinä näytetään komennon tuloste.

Koko teksti

blockstudio-llm-full.txt on dokumentaation ja kaikkien skeemojen täydellinen teksti yhdessä tiedostossa. Se luodaan ja julkaistaan edelleen, ja siihen voi yhä viitata täsmällisesti, mutta agentille ei enää anneta sitä ensimmäisenä. Tämä kerrotaan myös tiedoston omassa otsakkeessa.

Miten ne rakennetaan

Molemmat tiedostot koostetaan koontiversion luonnin yhteydessä komennolla npm run build:llm, joka suorittaa scripts/build-llm.ts-komennon. Skripti:

  1. lukee otsaketiedot jokaisen julkaistun dokumentin alusta kokoelmissa docs, guides ja registry saadakseen otsikon, reitin ja tarkoituksen.
  2. poimii kunkin dokumentin omasta sisällöstä sen omistamat tunnisteet: hook-nimet suodatin- ja toimintokutsuista, asetusskeemaa vasten validoidut asetuspolut, PHP-funktiot ja -luokat sekä CLI-komennot.
  3. kirjoittaa hakemiston kohteeseen includes/llm/blockstudio-llm.txt.
  4. käy dokumentaatiopuun läpi navigointijärjestyksessä, poistaa vain navigointia varten tarkoitetut Markdown-elementit säilyttäen otsikot ja koodiesimerkit, lisää JSON-skeemat ja kirjoittaa koko tekstin kohteeseen includes/llm/blockstudio-llm-full.txt.

npm run docs:check epäonnistuu, jos julkaistu dokumentti puuttuu hakemistosta tai jos hakemisto osoittaa tiedostoon, jota ei enää ole.

Käyttöohjeet

  1. Ota blockstudio.json-asetuksessa käyttöön asetus ai/enableContextGeneration:
JSON
{
  "ai": {
    "enableContextGeneration": true
  }
}
  1. Tiedostot ovat nyt saatavilla osoitteissa your-site.com/blockstudio-llm.txt ja your-site.com/blockstudio-llm-full.txt.

  2. Määritä tekoälytyökalun lähteeksi hakemisto:

    • Cursor: lisää URL dokumentiksi projektin asetuksiin.
    • Claude Code: viittaa kohteeseen URL tai lataa tiedosto ja lisää se projektin kontekstiin.
    • GitHub Copilot: sisällytä tiedosto säilöösi tai viittaa siihen ohjeissasi.

Mikä tahansa työkalu, joka hyväksyy URL- tai tekstitiedoston kontekstiksi, toimii. Molemmat tiedostot ovat staattisia eivätkä sisällä sivustokohtaisia tietoja, kuten rekisteröityjä lohkojasi tai nykyisiä asetuksia.

Projektisi oma sopimus

Hakemisto kuvaa kohdetta Blockstudio. Se ei kuvaa projektiasi, vaikka agentti tarvitsee myös nämä tiedot: missä lohkot ja sivut sijaitsevat, mitkä ominaisuudet ovat käytössä ja mikä analyysissä hylätään. vendor/bin/blockstudio-agents luo tämän tiedon blockstudio.json-määrityksistäsi ja tiedostoistasi. Katso projektisopimus.