search

cstb / citygml-energy

CityGML Energy ADE
43 stars 9 forks source link

Export the Gudelines document to markdown #58

Closed emunozh closed 9 years ago

emunozh commented 9 years ago

-- Label Documentation --

The markdown code needs to be compiled to the pdf format. An alternative to this is a complete migration of the project documentation to www.read-the-docs.org.

emunozh commented 9 years ago

Should we try to consolidate all documentation of the ADE in a single place? Currently I can find information/documentation of the ADE on 4 places/platforms:

  1. wiki at energy.sig3d
  2. github – wiki and github README + guidelines
  3. icloud
  4. dropbox

Moving the documentation to readthedocs can only work if we consolidate all the information onto this platform.

RomainNouvel commented 9 years ago

Hi Esteban, about 1: we agreed last meeting that the wiki (main page) should remain our external communication platform. Indeed, wiki is adapted for wide-audience without specific technical/programming knowledge.

For the rest, you're right, we should centralize/consolidate the information on ADE Energy for the development team as far as it is technically possible. Migrating the icloud content to the GitHub would be a good option, as well as the dropbox content.