La nuova documentazione di Freedomotic

In questo periodo sono stato particolarmente impegnato nella stesura della documentazione di Freedomotic. Il progetto sta crescendo decisamente soprattutto dopo l’Hacktoberfest che ha visto la partecipazione di molti nuovi contributors.

Uno dei punti deboli resta (lo è ancora perchè il lavoro ahimè non è concluso) la mancanza di una documentazione completa sia per gli utenti finali che per gli sviluppatori.

Finora avevamo poche pagine sul sito ufficiale e il wiki di Github. Quest’ultimo era aggiornato solo dal core team anche perchè non è facilissimo gestire le pull request provenienti da altri collaboratori.

La soluzione?

Utilizzare ReadTheDocs in modo da avere tutto il materiale online con possibilità di ricerca nonchè le versioni scaricabili in html, pdf ed epub.

Abbiamo creato due repository Github a cui chiunque può contribuire facilmente. RTD si basa su Sphinx ed  in particolare abbiamo adottato il formato restructuredText (.rst) al posto di markdown (.md) recuperando le pagine del wiki e quelle del sito.

In questa fase stiamo predisponendo la versione inglese ma in seguito, sfruttando la flessibilità del servizio, realizzeremo quella italiana e se possibile delle altre nelle lingue più diffuse.

Il manuale utente è accessibile a questo link http://freedomotic-user-manual.readthedocs.io/ mentre quello per gli sviluppatori all’indirizzo http://freedomotic-developer-manual.readthedocs.io/

Ribadisco che il lavoro non è finito quindi chiunque volesse dare una mano è il benvenuto!

Lascia una risposta

L'indirizzo email non verrà pubblicato. I campi obbligatori sono contrassegnati *

Utilizzando il sito, accetti l'invio dei cookies da parte nostra. Maggiori informazioni

Questo sito utilizza i cookies per fornire la migliore esperienza di navigazione possibile. Continuando ad utilizzarlo senza modificare le impostazioni o cliccando su "Accetta" acconsenti al loro utilizzo.

Chiudi