Lyra OSDocumentazione

Contribuisci

Contribuire alla documentazione

Suggerisci correzioni, segnala dubbi e aiuta a migliorare le guide per le altre persone.

ProceduraDocumentazione del sitoRevisione della documentazione: Tradotto dalla versione in portoghese revisionata il

Hai trovato una lacuna?

La documentazione segue l'evoluzione di Lyra OS. Un passaggio poco chiaro, un messaggio diverso nella tua versione o un argomento mancante sono buone occasioni per contribuire.

Apri il repository del sito e usa l'area issues per proporre una correzione. Indica la pagina, il passaggio, la versione di Lyra usata e il risultato che hai osservato. Per i difetti del sistema, usa i repository indicati nella guida di diagnostica.

Proponi una modifica

  1. Crea un fork del repository del sito su GitHub e un branch per la modifica.
  2. Modifica il contenuto dell'articolo in docs/content/. Il file catalog.json organizza titoli, descrizioni e categorie.
  3. Esegui python3 scripts/build-docs.py nella radice del progetto per generare le pagine e l'indice di ricerca.
  4. Controlla la navigazione, le istruzioni e la presentazione su uno schermo piccolo.
  5. Apri una pull request con la correzione e spiega su quale versione hai verificato la procedura.

Scrivi per chi userà il sistema

  • Inizia dall'obiettivo e dai requisiti della procedura.
  • Spiega l'effetto dei comandi prima di chiedere di eseguirli.
  • Evidenzia le operazioni che cancellano dati o modificano l'archiviazione.
  • Separa le funzioni rilasciate dai piani e dalle funzioni in sviluppo.
  • Includi un riferimento alle note di rilascio o alla documentazione del componente.

Traduci e aggiorna le traduzioni

Il portoghese è la lingua di origine delle guide. Le versioni in inglese, spagnolo e italiano si trovano in docs/content/en/, docs/content/es/ e docs/content/it/, ciascuna con il proprio catalog.json.

  • Mantieni lo stesso nome del file, gli stessi ID dei titoli h2 e i comandi invariati.
  • Quando revisioni una guida in portoghese, aggiorna anche le traduzioni o lasciale segnalate come non aggiornate.
  • Nel catalogo della traduzione, source_reviewed registra la data di revisione dell'originale in portoghese usato come base. Quando l'originale è più recente, la pagina tradotta mostra un avviso con un link alla versione in portoghese.