Pereiti prie turinio

DI integracija

Blockstudio pateikia du konteksto failus programavimo asistentams. Pirmasis – glausta dokumentacijos rodyklė. Antrajame pateikiamas visas kiekvieno dokumento ir schemos tekstas, skirtas įrankiams, kuriems reikia vienu užklausimu gauti visą turinį.

Agentas perskaito rodyklę, suranda reikalingą dokumentą ir jį atveria. Kita galimybė – pateikti agentui pusę megabaito nesurūšiuoto teksto, kuriame nieko negalima adresuoti ir įkeliamas visas turinys, nesvarbu, ar jis aktualus.

Rodyklė

blockstudio-llm.txt pateikia kiekvieną paskelbtą dokumentą po vieną kartą, sugrupuotą pagal skyrių ir poskyrį, kuriam jis priklauso, navigacijos tvarka. Kiekviename įraše nurodoma:

  • route: dokumentacijos URL.
  • file: Markdown šaltinio failo kelias Blockstudio saugykloje.
  • purpose: vienos eilutės dokumento paskirties aprašymas.
  • settings: blockstudio.json keliai, kuriuos valdo tas dokumentas.
  • hooks: dokumentui priklausantys PHP ir JavaScript filtrų bei veiksmų pavadinimai.
  • php: dokumentui priklausančios funkcijos, klasės ir metodai.
  • cli: dokumentui priklausančios komandos.
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()

Identifikatoriaus eilutė įrašoma tik tada, kai dokumentui iš tiesų priklauso atitinkamo tipo elementas, todėl aukščiau pateiktame įraše nėra cli eilutės, o statinio išankstinio atvaizdavimo puslapiui priklauso visa išankstinio atvaizdavimo komandų šeima.

Identifikatorių eilutės leidžia ieškoti rodyklėje. Agentas, ieškantis kablio, suveikiančio prieš atvaizduojant bloką, peržvelgia kablių eilutes ir randa PHP Kabliai dokumentą, kuriame pateikiamas visas filtrų ir veiksmų žodynas. Agentas, ieškantis statinio išankstinio atvaizdavimo, ieško to paties žodžio ir randa Statinis išankstinis atvaizdavimas bei Nustatymai dokumentus, kuriuose atitinkamai aprašyti skaitikliai ir konfigūracija. Penkios viešosios JSON schemos išvardytos taip pat, nurodant jų maršrutą ir failą.

Identifikatoriai nuskaitomi iš teksto, įterptojo kodo ir kodo pavyzdžių. Blokai, pažymėti text, talpina pažodinę išvestį ir katalogų sąrašus, todėl jie praleidžiami: vien tai, kad dokumente pateikiama komandos išvestis, nereiškia, kad dokumentui priklauso ta komanda.

Visas tekstas

blockstudio-llm-full.txt yra vienas failas su visa dokumentacija ir visomis schemomis. Jis vis dar generuojamas, skelbiamas ir adresuojamas, tačiau agentui nebepateikiamas pirmiausia – tai nurodyta ir jo antraštėje.

Kaip jie kuriami

Abu failus kūrimo metu surenka npm run build:llm, kuris paleidžia scripts/build-llm.ts. Skriptas:

  1. Nuskaito kiekvieno paskelbto dokumento priekinius metaduomenis iš docs, guides ir registry rinkinių, kad gautų jo pavadinimą, maršrutą ir paskirtį.
  2. Iš dokumento turinio ištraukia jam priklausančius identifikatorius: kablių pavadinimus iš filtrų ir veiksmų iškvietimų, nustatymų kelius, patikrintus pagal nustatymų schemą, PHP funkcijas ir klases bei CLI komandas.
  3. Įrašo rodyklę į includes/llm/blockstudio-llm.txt.
  4. Navigacijos tvarka pereina dokumentacijos medį, pašalina tik navigacijai skirtus Markdown, išsaugodamas antraštes ir kodo pavyzdžius, prideda JSON schemas ir įrašo visą tekstą į includes/llm/blockstudio-llm-full.txt.

npm run docs:check užduotis nepavyksta, jei paskelbtas dokumentas neįtrauktas į rodyklę arba jei rodyklėje nurodytas failas nebeegzistuoja.

Kaip juos naudoti

  1. Savo blockstudio.json įjunkite nustatymą ai/enableContextGeneration:
JSON
{
  "ai": {
    "enableContextGeneration": true
  }
}
  1. Failai dabar pasiekiami adresais your-site.com/blockstudio-llm.txt ir your-site.com/blockstudio-llm-full.txt.

  2. Nurodykite savo DI įrankiui rodyklę:

    • Cursor: projekto nustatymuose pridėkite URL kaip dokumentą.
    • Claude Code: nurodykite URL arba atsisiųskite failą ir įtraukite jį į projekto kontekstą.
    • GitHub Copilot: įtraukite failą į saugyklą arba nurodykite jį savo instrukcijose.

Tiks bet kuris įrankis, priimantis URL ar tekstinį failą kaip kontekstą. Abu failai yra statiniai ir juose nėra konkrečios svetainės duomenų, pavyzdžiui, registruotų blokų ar dabartinių nustatymų.

Jūsų projekto sutartis

Rodyklėje aprašytas Blockstudio. Ji neaprašo jūsų projekto, kuris sudaro kitą agentui reikalingos informacijos dalį: kur yra blokai ir puslapiai, kurios funkcijos įjungtos ir kokia analizė atmes pakeitimus. vendor/bin/blockstudio-agents tai sugeneruoja iš jūsų blockstudio.json ir failų. Žr. projekto sutartį.