Jamdesk Documentation logo

Come funziona Jamdesk

Dal push Git alla documentazione online in meno di 60 secondi. Scopri come Jamdesk crea, distribuisce e ottimizza il tuo sito senza infrastruttura da gestire.

Jamdesk crea siti di documentazione dai file MDX nel tuo repository GitHub. Scrivi Markdown con componenti React, esegui il push su GitHub e il tuo sito sarà online su un CDN globale in meno di 60 secondi. I contenuti restano nel repository come semplici file MDX, quindi puoi trasferirli a un altro strumento in qualsiasi momento.

Panoramica dell'architettura

Il tuo repository è la fonte autorevole. Jamdesk si connette al repository, crea il sito e lo distribuisce su una rete edge globale. Non devi gestire alcuna infrastruttura.

Come fluiscono i contenuti dal tuo repository ai tuoi utenti

La pipeline di build

In genere richiede 30-60 secondi dall'inizio alla fine. I build sono rapidi perché Jamdesk non esegue il pre-rendering delle pagine. I contenuti grezzi vengono inviati all'edge e le pagine vengono renderizzate su richiesta quando i visitatori le richiedono.

1
Recupero della sorgente

Esegui il push sul branch GitHub connesso (oppure seleziona Rebuild nel dashboard). Jamdesk clona il repository e individua la directory della documentazione.

2
Convalida

La configurazione docs.json viene convalidata rispetto allo schema e i link interni vengono controllati per individuare pagine inesistenti e anchor non validi.

3
Elaborazione dei contenuti

Jamdesk genera l'indice di ricerca, gli embedding per la chat AI, la sitemap, llms.txt e le regole di reindirizzamento dai tuoi contenuti.

4
Deploy sull'edge

I contenuti vengono caricati sul CDN e propagati in oltre 300 località edge. Vengono trasferiti solo i file modificati, quindi i nuovi deploy sono rapidi.

Incluso in ogni sito

Ogni sito include queste funzionalità per impostazione predefinita. Non è richiesta alcuna configurazione.

Ricerca AI

Ricerca in linguaggio naturale che comprende l'intento, non solo le parole chiave. Utilizza embedding vettoriali generati dai tuoi contenuti durante il build.

llms.txt

Indice leggibile dall'AI conforme alle specifiche di llmstxt.org. Gli assistenti di programmazione e gli agenti AI possono utilizzare direttamente la tua documentazione.

Elementi essenziali SEO

Sitemap, robots.txt, immagini Open Graph e meta tag. La tua documentazione è indicizzabile fin dal primo deploy.

Analytics integrato

Dashboard di analytics orientato alla privacy, senza cookie obbligatori. Oppure usa il tuo strumento: Jamdesk supporta Google Analytics, Plausible, PostHog e altri.

Cosa attiva un build

Un push Git sul branch connesso, il pulsante Rebuild nel dashboard oppure jamdesk deploy dalla CLI. Se esegui il push di più commit in rapida successione, Jamdesk li raggruppa in un unico build per evitare di consumare risorse inutilmente.

Per i dettagli operativi (monitoraggio dello stato, rollback, variabili d'ambiente e deploy dei branch), consulta Ciclo di build e deploy.

Sicurezza e infrastruttura

Non devi occuparti di questi aspetti, ma se il tuo team di sicurezza lo chiede: i build vengono eseguiti in container isolati e la connessione alla tua GitHub App è di sola lettura.

Permessi minimi

La GitHub App richiede solo l'accesso in lettura ai repository selezionati. L'app non dispone dell'accesso in scrittura e non richiede ambiti a livello dell'intera organizzazione.

Build isolati

Ogni build viene eseguito nel proprio container, che viene eliminato dopo il deploy. Nulla persiste tra build o clienti diversi.

HTTPS ovunque

Certificati SSL automatici per domini personalizzati e sottodomini. I certificati vengono emessi e rinnovati automaticamente.

CDN globale

I contenuti vengono distribuiti dalla rete di Cloudflare, con oltre 300 località edge e un uptime del 99,9%.

Prestazioni

La possibilità che la tua documentazione venga trovata dipende anche dalla velocità di caricamento. Google utilizza i Core Web Vitals come segnale di ranking e i crawler AI come GPTBot e ClaudeBot si concedono da 1 a 5 secondi per pagina. Se la documentazione non si carica entro questo intervallo, non verrà citata.

Ogni sito Jamdesk viene distribuito dall'edge con un tempo al primo byte inferiore a 50 ms. È sufficientemente veloce per le soglie di ranking di Google e consente ai crawler AI di recuperare e citare i contenuti.

MetricaValore tipico
Durata del build30-60 secondi
Propagazione del deploy< 30 secondi
Primo byte (edge)< 50 ms
Caricamento completo della pagina< 500 ms

Prossimi passaggi

Crea un progetto

Configura un nuovo sito di documentazione nel dashboard

Connetti GitHub

Collega il tuo repository per abilitare i build automatici

Anteprima locale

Usa la CLI di Jamdesk per visualizzare in anteprima e convalidare la documentazione prima del push