Versione della documentazione · CLI 7.30.1 · SDK 2.6.53. Desktop usa il runtime incluso nella propria versione. Comandi ed esempi restano identici al testo inglese. Testo inglese

Creare e usare il primo AX Wiki

Prima di iniziare

AX Wiki trasforma fonti selezionate del repository in pagine di architettura e flussi di lavoro. È conoscenza del repository, distinta dalla documentazione web di AX Code. Prima collega un fornitore e scegli un modello utilizzabile. La generazione invia le prove selezionate al fornitore e può comportare costi.

Esegui dalla cartella del progetto. I progetti Git usano la radice del worktree più vicino anche partendo da una sottocartella. Controlla il checkout e decidi se versionare i file generati.

Anteprima e generazione

Il piano mostra file e pagine selezionati senza chiamare il modello. Esaminalo prima di generare:

ax-code wiki plan

Genera poi con il modello configurato, valida il risultato e apri il lettore locale:

ax-code wiki generate
ax-code wiki doctor
ax-code wiki viz --open

L’uscita predefinita è .ax-wiki/, con ingresso da .ax-wiki/quickstart.md; .ax-wiki/.manifest.json registra fonti e hash. La generazione può aggiornare il blocco di rimando Wiki in AGENTS.md; usa --skip-agents per saltare il passaggio. Esamina il diff risultante.

Leggere e fare domande utili

Parti dalla pagina introduttiva, segui i file citati e chiedi dove è implementato un flusso. Il visualizzatore mostra pagine, citazioni e relazioni registrate. Interrompi il visualizzatore CLI in primo piano con Ctrl+C.

Usa il Wiki per orientarti, poi esamina codice e test attuali. Per simboli, chiamanti e riferimenti esatti usa l’intelligenza del codice o LSP. Una pagina aggiornata non prova copertura completa, correttezza o prestazioni reali.

Mantenere aggiornato

Dopo modifiche alle fonti, aggiorna le pagine interessate e controllane lo stato:

ax-code wiki update
ax-code wiki status
ax-code wiki doctor

Il comando di stato può riuscire anche senza Wiki; controlla esistenza e salute riportate. Output obsoleto o non sano richiede indagine. Il visualizzatore CLI usa un’istantanea fissa: riaprilo dopo l’aggiornamento.

Nelle versioni TUI attuali, /wiki-viz apre il visualizzatore e richiede manutenzione. La manutenzione interattiva durante l’inattività è attiva di default; il lavoro in primo piano ha priorità. Le esecuzioni headless non attivano questo pianificatore.

Controllare la generazione

Integra queste impostazioni facoltative nel file di progetto ax-code.json. Sostituisci l’ID con un modello disponibile dalla connessione. L’esempio disattiva la manutenzione in background mantenendo i comandi espliciti:

{
  "wiki": {
    "enabled": true,
    "auto": false,
    "model": "provider/model"
  }
}

Un --model provider/model esplicito sostituisce il modello Wiki per quella chiamata. I modelli di ragionamento richiedono controlli riconosciuti per ragionamento basso o disattivato; scegli un altro modello supportato se la regola rifiuta la richiesta.

Inserisci le note dei manutentori in blocchi protetti perché sopravvivano agli aggiornamenti:

<!-- AX-WIKI:PROTECTED:START project-note -->

Deployment requires maintainer review.

<!-- AX-WIKI:PROTECTED:END -->

Recuperare dai problemi

Modello assente o autenticazione fallita: verifica accesso al fornitore e modello Wiki configurato. Un modello chat funzionante non garantisce che un modello Wiki distinto sia utilizzabile.
Timeout o compilazione interrotta: esamina ax-code wiki doctor e .ax-wiki/.build-report.json, poi riprova dopo aver risolto la causa. Le pagine temporanee validate possono essere riutilizzate; un errore non significa che tutte le pagine siano state pubblicate.
Conflitto di modifica manuale: conserva le note nei blocchi protetti e controlla le modifiche prima di riprovare. --force consente di sostituire modifiche fuori da questi blocchi; usalo intenzionalmente.

Passaggi successivi

Configurazione Wiki, CI e risoluzione problemi · Visualizzatore ed esportazione offline · Selezione modelli · Indice della documentazione