search

VCityTeam / UD-SV

7 stars 3 forks source link

Improve the documetation integration and use CI to generate the docs #56

Closed EricBoix closed 2 years ago

EricBoix commented 5 years ago

Integrate the documentation formats of UD-Viz

The Javascript code uses JSDoc (the way iTowns does it). Aside from this code intrusive documentation there also exist some markdown documents (e.g. here and there). Find a way to integrate both documents (or use only one) so that there is a unique gateway to the integrated doc.

Use CI to generate the documentation and make it available online

Hookup Continuous Integration to UD-Viz documentation and have it generate the corresponding artifacts in order for them to be available online (and also to have some coarse idea of the quality of the documentation)

EricBoix commented 2 years ago

Done. Refer to this UD-Viz issue. Closing.