Ενσωμάτωση AI
Το Blockstudio διαθέτει δύο αρχεία περιβάλλοντος για βοηθούς προγραμματισμού. Το κύριο είναι ένα συνοπτικό ευρετήριο της τεκμηρίωσης. Το δεύτερο περιέχει το πλήρες κείμενο κάθε εγγράφου και σχήματος, για εργαλεία που θέλουν ολόκληρο το σώμα τεκμηρίωσης σε ένα αίτημα.
Ένας agent διαβάζει το ευρετήριο, εντοπίζει το έγγραφο που χρειάζεται και το ανοίγει. Η εναλλακτική είναι να δοθούν σε έναν agent μισό megabyte αδιαφοροποίητου πεζού κειμένου, όπου τίποτα δεν έχει διεύθυνση και φορτώνονται τα πάντα είτε είναι σχετικά είτε όχι.
Το ευρετήριο
Το blockstudio-llm.txt παραθέτει μία φορά κάθε δημοσιευμένο έγγραφο, ομαδοποιημένο ανά ενότητα και υποενότητα, με τη σειρά πλοήγησης. Κάθε καταχώριση περιλαμβάνει:
route: το URL της τεκμηρίωσης.file: τη διαδρομή πηγής Markdown στο αποθετήριο Blockstudio.purpose: μία γραμμή που περιγράφει τον σκοπό του εγγράφου.settings: τις διαδρομέςblockstudio.jsonπου ανήκουν στο έγγραφο.hooks: τα ονόματα φίλτρων και ενεργειών PHP και JavaScript που ανήκουν στο έγγραφο.php: τις συναρτήσεις, κλάσεις και μεθόδους που ανήκουν στο έγγραφο.cli: τις εντολές που ανήκουν στο έγγραφο.
## 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()
Μια γραμμή αναγνωριστικού γράφεται μόνο όταν το έγγραφο έχει πράγματι κάτι αυτού του είδους, γι’ αυτό το παραπάνω παράδειγμα δεν έχει γραμμή cli, ενώ η σελίδα στατικής προαπόδοσης κατέχει ολόκληρη την οικογένεια εντολών προαπόδοσης.
Οι γραμμές αναγνωριστικών κάνουν το ευρετήριο αξιοποιήσιμο για απαντήσεις. Ένας agent που αναζητά το hook που εκτελείται πριν από την απόδοση ενός block σαρώνει τις γραμμές των hooks και καταλήγει στις PHP Hooks, όπου βρίσκεται ο πλήρης κατάλογος φίλτρων και ενεργειών. Ένας agent που αναζητά τη στατική προαπόδοση σαρώνει για την ίδια λέξη και καταλήγει στις Static Prerendering και Settings, όπου βρίσκονται αντίστοιχα οι μετρητές και οι ρυθμίσεις. Τα πέντε δημόσια σχήματα JSON παρατίθενται με τον ίδιο τρόπο, μαζί με τη διαδρομή και το αρχείο τους.
Τα αναγνωριστικά διαβάζονται από πεζό κείμενο, ενσωματωμένο κώδικα και παραδείγματα κώδικα. Τα block που επισημαίνονται ως text περιέχουν κυριολεκτική έξοδο και καταλόγους, οπότε παραλείπονται: ένα έγγραφο που εμφανίζει την έξοδο μιας εντολής δεν σημαίνει ότι κατέχει αυτή την εντολή.
Το πλήρες κείμενο
Το blockstudio-llm-full.txt είναι η πλήρης τεκμηρίωση και όλα τα σχήματα σε ένα αρχείο. Εξακολουθεί να παράγεται, να δημοσιεύεται και να έχει διεύθυνση, αλλά δεν είναι πλέον το πρώτο περιεχόμενο που δίνεται σε έναν agent, και αυτό αναφέρεται στην επικεφαλίδα του.
Πώς δημιουργούνται
Και τα δύο αρχεία συναρμολογούνται κατά τη δημιουργία από το npm run build:llm, το οποίο εκτελεί το scripts/build-llm.ts. Το σενάριο:
- Διαβάζει τα frontmatter όλων των δημοσιευμένων εγγράφων στις συλλογές
docs,guidesκαιregistry, για να πάρει τον τίτλο, τη διαδρομή και τον σκοπό τους. - Εξάγει από το σώμα κάθε εγγράφου τα αναγνωριστικά που του ανήκουν: ονόματα hook από κλήσεις φίλτρων και ενεργειών, διαδρομές ρυθμίσεων που επικυρώνονται βάσει του σχήματος ρυθμίσεων, συναρτήσεις και κλάσεις PHP και εντολές CLI.
- Εγγράφει το ευρετήριο στο
includes/llm/blockstudio-llm.txt. - Διατρέχει το δέντρο τεκμηρίωσης με τη σειρά πλοήγησης, αφαιρεί τα Markdown που αφορούν μόνο την πλοήγηση διατηρώντας τις επικεφαλίδες και τα παραδείγματα κώδικα, προσθέτει τα σχήματα JSON και εγγράφει το πλήρες κείμενο στο
includes/llm/blockstudio-llm-full.txt.
Το npm run docs:check αποτυγχάνει αν λείπει από το ευρετήριο κάποιο δημοσιευμένο έγγραφο ή αν το ευρετήριο δείχνει σε αρχείο που δεν υπάρχει πλέον.
Πώς να τα χρησιμοποιήσετε
- Ενεργοποιήστε τη ρύθμιση
ai/enableContextGenerationστοblockstudio.jsonσας:
{
"ai": {
"enableContextGeneration": true
}
}
-
Τα αρχεία είναι πλέον διαθέσιμα στα
your-site.com/blockstudio-llm.txtκαιyour-site.com/blockstudio-llm-full.txt. -
Συνδέστε το εργαλείο AI σας με το ευρετήριο:
- Cursor: προσθέστε το URL ως έγγραφο στις ρυθμίσεις του έργου σας.
- Claude Code: αναφέρετε το URL ή κατεβάστε το αρχείο και προσθέστε το στο περιβάλλον του έργου σας.
- GitHub Copilot: συμπεριλάβετε το αρχείο στο αποθετήριό σας ή αναφέρετέ το στις οδηγίες σας.
Θα λειτουργήσει οποιοδήποτε εργαλείο δέχεται ένα URL ή αρχείο κειμένου ως περιβάλλον. Και τα δύο αρχεία είναι στατικά και δεν περιλαμβάνουν δεδομένα συγκεκριμένα για τον ιστότοπο, όπως τα καταχωρισμένα blocks ή τις τρέχουσες ρυθμίσεις σας.
Το συμβόλαιο του δικού σας έργου
Το ευρετήριο περιγράφει το Blockstudio. Δεν περιγράφει το δικό σας έργο, δηλαδή το άλλο μισό όσων χρειάζεται ένας agent: πού βρίσκονται τα blocks και οι σελίδες, ποιες λειτουργίες είναι ενεργοποιημένες και ποια ανάλυση θα απορρίψει. Το vendor/bin/blockstudio-agents το δημιουργεί από το blockstudio.json και τα δικά σας αρχεία. Δείτε το συμβόλαιο έργου.