A documentation of the OEFamily is missing - Community Compendium

OpenEnergyPlatform / organisation

Repository for discussing and documenting decisions about the Open Energy Family

https://openenergyplatform.github.io/organisation/

GNU Affero General Public License v3.0

10 stars 4 forks source link

A documentation of the OEFamily is missing - Community Compendium #52

Closed Ludee closed 1 year ago

Ludee commented 1 year ago

We decide for MkDocs (over ReadTheDocs). Start with a general description and describe all modules.

jh-RLI commented 1 year ago

I also found out about this tool. Quite similar to mkdocs but maybe even better https://docusaurus.io/ https://github.com/facebook/docusaurus

jh-RLI commented 1 year ago

I think readthedocs is overkill, I really want to go for the simplest solution.

henhuy commented 1 year ago

docusauraus looks nice, but I wanted to remark that you have to install node.js in order to use it. Mkdocs is based on python only...

jh-RLI commented 1 year ago

That's true, I'm aware of that :) . Since apps like the oeo-viewer(react based app) are integrated in the oeplatform django project, we need nodejs anyway. So it is at least an option for the OEP. But if mkdocs is as easy, I don't mind, and it might fit better with RLI's know-how.

jh-RLI commented 1 year ago

Also we should add a OEF README that will be visible to the public and one that will be visible to members. This should help to guide people: