search

geli-lms / geli

geli is an open source e-learning platform
Apache License 2.0
151 stars 70 forks source link

Document core components #426

Open micpah opened 6 years ago

micpah commented 6 years ago

User Story

As a:

newbie

I want:

a documentation/introduction about geli's core components (for backend and frontend)

so that:

"I may perceive whatever holds The world [=geli] together in its inmost folds (Goethe)"

Acceptance criteria:

Additional info:

It can be a written docu of the introduction which was given by @lukaskorte at the beginning of this semester (WS2017/18).

Please tag this issue if you are sure to which tag(s) it belongs.

aeimer commented 6 years ago

It would be great if use automated documentation tools that generate Docs from CodeComments. Something I really would like to have, is a List of URL-Paths with their corresponding component/controller.