Jamdesk Documentation logo

Correggi con AI

Esamina e applica dalla dashboard di build Jamdesk le correzioni AI per link non funzionanti e descrizioni mancanti, con commit su GitHub.

Quando una build termina con link non funzionanti o pagine prive di descrizione, Jamdesk può correggerne molti automaticamente. Il pulsante Fix with AI legge gli avvisi della build, propone una modifica concreta per ciascuno e applica le correzioni approvate con un commit nel repository GitHub collegato, avviando una nuova build. Questa pagina è destinata a chi gestisce un sito Jamdesk e vuole eliminare gli avvisi della build senza modificare manualmente i file MDX.

Gli screenshot mostrano l'interfaccia in inglese.

Per una versione locale, basata sul terminale, della stessa funzionalità, consulta il comando CLI jamdesk fix. Il flusso della dashboard esegue il commit per te; la CLI scrive nella copia di lavoro e lascia a te il commit.

Cosa corregge

Fix with AI funziona su tre tipi di avvisi della build:

  • Link interni non funzionanti. Un frammento di link che punta a un'intestazione non più esistente nella pagina di destinazione, ad esempio un errore di battitura (#instalation#installation) o una pagina tradotta la cui intestazione è stata rinominata.
  • Descrizioni di pagina mancanti. Una pagina senza description nel frontmatter. Jamdesk scrive un breve riepilogo ricavato dal contenuto della pagina, che puoi esaminare.
  • Titoli di pagina mancanti. Per una pagina senza titolo viene suggerito un titolo ricavato dal contenuto, che puoi esaminare.

Propone una modifica solo quando riesce a risolvere la destinazione con sufficiente certezza. Gli elementi ambigui rimangono invariati e vengono elencati separatamente, così puoi correggerli manualmente.

Il numero di elementi correggibili non corrisponde al numero di avvisi. Una build può mostrare cinque avvisi mentre Fix with AI ne propone la correzione per tre, perché per gli altri due non esiste una correzione non ambigua. Il banner riflette sempre ciò che può essere effettivamente corretto.

Prerequisiti

  • Un repository GitHub collegato al progetto.
  • Accesso in scrittura per l'app GitHub di Jamdesk, affinché possa eseguire il commit delle correzioni. Se manca l'accesso, la finestra modale mostra un link Grant access che porta a GitHub per aggiungerlo.
  • Una build completata che contenga avvisi relativi a link non funzionanti o descrizioni mancanti.

Trova il banner

Apri il progetto e scorri fino a Build History nella pagina Project Home. Quando l'ultima build presenta problemi correggibili, sopra l'elenco delle build compare un banner con il numero di problemi e un pulsante Fix with AI.

Un pannello della cronologia delle build con un banner evidenziato che indica che 3 problemi di questa build possono essere corretti con l'AI, accanto a un pulsante Fix with AI. La riga della build più recente mostra uno stato di successo con un badge di avviso pari a 5.

Il banner compare solo nella build completata più recente. Le build precedenti nella cronologia non lo mostrano, perché le correzioni vengono sempre applicate allo stato corrente della documentazione.

Rivedi e applica le correzioni

1
Apri l'anteprima

Fai clic su Fix with AI. Si apre la finestra modale e l'agente AI esamina la documentazione per creare un piano di correzione. L'operazione richiede alcuni secondi.

2
Leggi ogni modifica proposta

Le correzioni sono raggruppate per tipo. Broken links mostra ogni ancora riscritta, Missing descriptions mostra il riepilogo suggerito per ogni pagina e Missing titles mostra il titolo proposto. Deseleziona la casella di qualsiasi elemento che preferisci saltare questa volta oppure usa il pulsante per ignorarlo e silenziare definitivamente un suggerimento. I problemi senza una correzione chiara compaiono in Can't be fixed automatically e devono essere gestiti manualmente.

La finestra modale Fix with AI. Una sezione Broken links elenca tre correzioni selezionate, ognuna con la vecchia ancora barrata e quella corretta. Una sezione Can't be fixed automatically elenca due problemi da correggere manualmente, sopra i pulsanti Cancel e Apply 3 fixes.
3
Applica

Fai clic su Apply fixes. Jamdesk esegue il commit delle modifiche selezionate nel branch collegato, usando il messaggio docs: apply AI-suggested fixes (via Jamdesk), quindi avvia una nuova build.

4
Conferma la nuova build

Controlla la nuova build in Build History. Quando diventa disponibile, gli avvisi corretti sono scomparsi. Quelli rimasti sono avvisi che Fix with AI non ha potuto risolvere oppure nuovi problemi derivanti dai contenuti più recenti.

L'applicazione delle correzioni scrive un commit reale nel repository, quindi la modifica viene tracciata nella cronologia Git e puoi esaminarla o annullarla su GitHub come qualsiasi altro commit.

Quando alcuni problemi non possono essere corretti

Se un avviso non ha una correzione chiara, la finestra modale lo elenca sotto un'intestazione separata e lo lascia invariato. Motivi comuni:

  • Un link non funzionante la cui pagina o intestazione di destinazione non esiste in alcun punto, quindi non c'è una destinazione a cui puntare.
  • Una voce di navigazione senza un file sorgente corrispondente.
  • Una pagina per cui l'agente non ha potuto generare automaticamente una descrizione.

Questi problemi richiedono una modifica manuale. Apri la pagina nell'editor o nel tuo editor di codice, correggi il link o aggiungi la descrizione, quindi esegui il push per avviare una nuova build.

Ignora i suggerimenti

Alcuni avvisi non richiedono interventi: ad esempio un link interrotto intenzionalmente o una pagina segnaposto che non necessita di descrizione. Deselezionare una correzione la salta solo una volta. Ignorarla la rimuove dal conteggio finché non decidi diversamente.

Ogni riga nella finestra modale, correggibile o meno, dispone di un pulsante per ignorarla. Fai clic sul pulsante: l'elemento viene spostato in una sezione Ignored compressa in fondo. Dopo aver chiuso la finestra modale, il conteggio del banner nella pagina Project Home diminuisce di conseguenza e gli avvisi corrispondenti scompaiono da Build History, nella build corrente e in tutte quelle successive. Ignore all fa lo stesso per tutti gli elementi ancora elencati.

Comportamento degli elementi ignorati:

  • Condivisi e persistenti. Gli elementi ignorati si applicano all'intero progetto, quindi tutti i membri vedono lo stesso elenco e le esclusioni rimangono valide tra le build. Jamdesk identifica ogni avviso in base al contenuto anziché al numero di riga, perciò modificare altre parti della pagina non farà ricomparire un elemento ignorato.
  • Ripristino. Espandi la sezione Ignored e fai clic su Restore per qualsiasi elemento. Se ignori tutti gli elementi di una build, il banner scompare e un piccolo link "N ignored recommendations" sotto Build History riapre la finestra modale.
  • Gli avvisi modificati ricompaiono. Se il problema sottostante cambia, ad esempio se il link non funzionante punta ora altrove, non corrisponde più alla voce ignorata e viene mostrato di nuovo come nuovo suggerimento.

Fix with AI e CLI a confronto

Entrambi gli strumenti correggono le ancore dei link non funzionanti. Differiscono per il luogo di esecuzione e per il modo in cui viene applicata la modifica.

Fix with AI (dashboard)jamdesk fix (CLI)
EsecuzioneNella dashboard, su una buildNel terminale, sui file locali
CorrezioniLink non funzionanti e descrizioni mancantiAncore di link non funzionanti
CommitEsegue il commit nel branch per teScrive nei file locali; il commit è a tuo carico
AvvioUn clic sul banner della buildjamdesk fix

Usa il flusso della dashboard per una correzione rapida senza uscire da Jamdesk. Usa la CLI quando vuoi prima applicare le modifiche alla copia di lavoro, ad esempio per raggrupparle con altre modifiche.

Cosa fare ora?

Monitoraggio build

Monitora lo stato delle build e leggi avvisi e suggerimenti

Correggi link non funzionanti (CLI)

Correggi automaticamente i link non funzionanti dal terminale