italia / docs-italia-comandi-conversione

Comandi di conversione di formato per Docs Italia
GNU Affero General Public License v3.0
7 stars 3 forks source link

rimuovere `document.rst` #4

Closed danse closed 6 years ago

danse commented 6 years ago

attualmente convert.hs produce un document.rst ed un index.rst. @atorin suggerisce di rimuovere document.rst per evitare confusione.

la conversione da singolo documento a multiple sezioni è soggetta ad errore, per questo penso sia una buona idea mantenere il documento singolo a disposizione degli utenti. potremmo cambiare la struttura delle cartelle in modo che sia più chiara.

document.rst è anche usato per rilevare e contare gli errori di sintassi, il che è più complesso da fare sui files sphinx. anche questo si può continuare a fare con una struttura diversa delle cartelle

danse commented 6 years ago

ho aggiunto una sezione nel readme chiarendo la duplicazione https://github.com/italia/pandoc-docs2rst#documento-convertito-e-files-strutturati

danse commented 6 years ago

in realtà mantenere i risultati intermedi aiuta molto la risoluzione di errori relativa ad uno specifico stadio di conversione. al momento abbiamo:

quando le varie parti evolvono riscontriamo dei cambiamenti ed è importante che siano facilmente attribuibili. l'interfaccia utente va semplificata, potremmo farlo in un repo separato chiamato convert-docs-italia che contenga solo il comando, non i test di regressione

danse commented 6 years ago

in realtà mantenere i risultati intermedi aiuta molto la risoluzione di errori relativa ad uno specifico stadio di conversione. al momento abbiamo:

quando le varie parti evolvono riscontriamo dei cambiamenti ed è importante che siano facilmente attribuibili. l'interfaccia utente va semplificata, potremmo farlo in un repo separato chiamato convert-docs-italia che contenga solo il comando, non i test di regressione