Vai al contenuto

Documentazione

Documentazione

Scritta sulla build così com’è oggi. Tutto ciò che non è ancora implementato è segnalato, invece di essere descritto come se esistesse.

Requisiti

Questi sono i requisiti della prima build, quella per WordPress. Ogni altra piattaforma ha la sua build con i suoi requisiti, e lo stato di ciascuna è su Funziona con il tuo CMS.

  • WordPress 6.0 o successivo
  • PHP 8.1 o successivo
  • Una chiave API di OpenAI, Anthropic, Google o Mistral
  • Nessuna dipendenza da cron, nessun accesso alla shell, nessun Node sul server

Installazione

  1. Plugin, Aggiungi nuovo, Carica plugin, scegli lo zip, Installa ora.
  2. Attiva.
  3. Impostazioni, DFYe. Incolla la chiave del tuo modello e salva.

La prima indicizzazione parte subito. Su un sito grande continua in background e il widget entra in funzione appena si conclude la prima passata.

Scegliere cosa viene indicizzato

Per impostazione predefinita DFYe indicizza ogni articolo, pagina e prodotto pubblicato. Non indicizza mai:

  • Tutto ciò che il tuo plugin SEO segna come noindex
  • Tutto ciò che è protetto da password o privato
  • Bozze, revisioni e contenuti nel cestino

Un interruttore per singolo contenuto nella barra laterale dell’editor esclude tutto il resto.

Personalizzare l’aspetto del widget

Ogni scelta visiva è una proprietà CSS personalizzata sull’host del widget. Le imposti nel pannello delle impostazioni, oppure nel tuo tema se preferisci tenere tutto nel codice:

dfye-chat {
  --dfye-action:    #6c4dff;   /* il tuo colore d’accento: la bolla della domanda, il pulsante di invio, il launcher */
  --dfye-action-on: #ffffff;   /* il testo sull’accento */
  --dfye-bg:        #ffffff;   /* l’intestazione e l’area di scrittura */
  --dfye-surface:   #ffffff;   /* il pannello */
  --dfye-ink:       #0b0d12;   /* il testo */
  --dfye-radius:    18px;
  --dfye-font:      "Your Face", system-ui, sans-serif;
}

Il widget usa di default il font di sistema di chi ti visita, e lo fa di proposito, così non costringe mai il tuo sito a scaricare un carattere. Passagli il tuo con --dfye-font. La modalità scura è automatica; fissala con data-theme="dark" sull’elemento se il tuo sito è sempre scuro.

Il widget viene renderizzato dentro uno shadow root, quindi niente del tuo tema entra e niente del widget esce. Per questo queste proprietà sono l’intera superficie di personalizzazione: non c’è nessun foglio di stile con cui combattere.

L’embed, su qualsiasi piattaforma

Il widget è un semplice script e non gli interessa cosa ha generato la pagina attorno a lui, quindi funziona su un CMS che non ha ancora una build del plugin e su un sito senza nessun CMS. Quello che il plugin aggiunge è la lettura: la scansione delle tue pagine pubblicate, l’indice che resta aggiornato quando ne modifichi una, e il registro delle domande. Un solo tag script per il widget fluttuante:

<script src="https://dfye.com/w.js" data-dfye="demo" defer></script>

Oppure un contenitore per un pannello inline, che è quello che usa la pagina demo:

<div data-dfye-inline data-opening="Chiedimi quello che vuoi."></div>
<script src="https://dfye.com/w.js" defer></script>

Budget di peso

La build fallisce se il widget supera i 20kB gzipped. La build attuale è di 9.7kB gzipped, 8.3kB brotli, 27.1kB raw. Quel numero lo scrive in questa pagina la build stessa, quindi non può allontanarsi dalla realtà.

Non ancora realizzato

Elenco onesto di ciò che questa documentazione descrive ma che il plugin oggi non fa:

  • La build per WordPress stessa. Il widget e il motore di recupero sono pronti; il prossimo passo è il wrapper PHP, e ogni altra piattaforma elencata su Funziona con il tuo CMS viene dopo.
  • La chiave di licenza e l’endpoint di aggiornamento.
  • Il registro delle domande nell’area di amministrazione.

L’avanzamento è tracciato sulla pagina di lancio e viene aggiornato quando le cose arrivano, non prima.

Metti una risposta vera su ogni pagina.

Fai una domanda al widget di questo sito e guardalo citare la pagina, oppure rifiutare. È lo stesso plugin, che gira sugli stessi contenuti che stai leggendo.