Skip to content

Complete documentation: bilingual MkDocs Material site (EN default, IT)#158

Merged
31December99 merged 11 commits into
31December99:mainfrom
spadieri85:docs-overhaul
Jun 10, 2026
Merged

Complete documentation: bilingual MkDocs Material site (EN default, IT)#158
31December99 merged 11 commits into
31December99:mainfrom
spadieri85:docs-overhaul

Conversation

@spadieri85

Copy link
Copy Markdown
Contributor

Cosa cambia

  • Sito bilingue: inglese di default, italiano selezionabile dal selettore lingua nell'header (plugin mkdocs-static-i18n)
  • Da 5 a 24 pagine per lingua (48 file totali)
  • Tema Material for MkDocs: ricerca (EN+IT), dark/light mode, tab di navigazione, pulsante copia sui blocchi di codice
  • Nav riorganizzata in 5 sezioni: Installation · Configuration · Usage · Guides · Reference (tradotte automaticamente in italiano)

Distribuzione del sito: nulla cambia

La pubblicazione di https://31december99.github.io/Unit3Dup/ resta identica: GitHub Pages dal branch gh-pages, col solito mkdocs gh-deploy. La versione italiana finisce automaticamente sotto il percorso /it. Dopo il merge basta rilanciare il deploy.

Le uniche dipendenze nuove servono solo per l'anteprima in locale (e per il deploy):

pip install -r docs/requirements.txt
cd docs
mkdocs serve   # anteprima su http://127.0.0.1:8000

Contenuti

  • Tutti i 49 flag CLI documentati (Reference → All commands)
  • Tutte le chiavi di Unit3Dbot.json con tipo, default e obbligatorietà (Reference → Full config)
  • FAQ con i messaggi d'errore reali del bot e relative soluzioni
  • Guide passo-passo: primo upload, documenti PDF, giochi (setup IGDB via Twitch)
  • Pagine dedicate a: multi-tracker, reseed, watcher, ricerca, FTP, sistema tag (tags_list.json, ban_list.json, sign_list.json)
  • I contenuti esistenti (guida ultra.cc, workflow oggetti) sono stati riciclati nelle nuove pagine, non buttati
  • Tutto derivato dal codice sorgente (command.py, settings.py, manager) — niente comportamenti inventati

Fix inclusi

  • La vecchia doc citava "Unit3D.json": corretto in Unit3Dbot.json ovunque
  • README: aggiunto link alla home dei docs e aggiornato il link comandi (l'URL vecchio /commands/ si sarebbe rotto)
  • .gitignore: aggiunto docs/site/ (output di build locale)

mkdocs build --strict passa senza warning su entrambe le lingue.

Domande aperte

  1. SIS: nel codice c'è solo l'URL placeholder — documentato in modo generico. Mi dici qual è così completo la riga?
  2. .readthedocs.yaml: punta a docs/conf.py (Sphinx) che non esiste — lo rimuovo in una PR successiva o preferisci configurare ReadTheDocs?

@spadieri85

Copy link
Copy Markdown
Contributor Author

Conflitti risolti: merge di main nel branch.

Il tuo nuovo "Quick start / HOW TO" (guide.md) era in conflitto col file smembrato — contenuto integrato nelle nuove pagine così:

  • Quick start → già coperto da Guides → First upload step by step e Configuration → Getting started
  • Spiegazione ban_list.json → corretta la nostra descrizione in Usage → Tags and titles (entrambe le lingue) con la tua semantica: esclusione di tipi di tag dall'autobuild, con i tuoi esempi JSON
  • Nota "-b non rinomina il file" → aggiunta
  • Esempi di versione aggiornati a 0.11.11

mkdocs build --strict ok su entrambe le lingue.

@31December99 31December99 merged commit ad54ed2 into 31December99:main Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants