sonia-auv / documentation

The S.O.N.I.A. Software documentation.
http://sonia-auv.readthedocs.org/
1 stars 2 forks source link

Review documentation creation process and add automation to it #10

Closed gauthiermartin closed 4 years ago

gauthiermartin commented 4 years ago

Review how we will generate our documentation, it would be nice to have a repo template to generate project specific documentation and auto generate documentation on read the docs

gauthiermartin commented 4 years ago

Should we consider github wiki pages ?

https://guides.github.com/features/wikis/

kevincharbonneau commented 4 years ago

Ok so basically I have looked at the following tools :

Paid

Open-source / Free

I believe that Paid solutions are either overkill or overpriced for the purpose they might serve.

The question is now, would using simply github wikis for each github project be fine or would it be preferable to host a larger documentation ?

I think that the easiest solution would be to use a centralized documentation with a tool like Wiki.js.

kevincharbonneau commented 4 years ago

closing issue due to wikijs solution adopted https://github.com/sonia-auv/wiki-js/issues/1