Clarifying build of dev.loklak.org site

[mariobehling]

I am unclear how this repository is supposed to work and except for "do not add issues" I do not find relevant info.

Right now the site only holds the server documentation. How can contributors add other relevant repositories and trigger the build?

I think the following would be expected:

• The script should probably stay in this repository, but the question is how can it be triggered?
• The Readme.md of this repository should be the start page of dev.loklak.org and it should list all repositories that are included in this repo
• There should be information "How to add other repositories to dev.loklak.org"

[yukiisbored]

Here's the how-to, I hope it'll clear some ambiguity and questions. https://github.com/loklak/dev.loklak.org/wiki/How-to-add-documentations-to-dev.loklak.org

[mariobehling]

In the "how to" you write:

Make sure the documentation is a static website and it’s located in a separated branch in the repository.

This is not the case for the loklak_server repository. Am I missing something?

[mariobehling]

Sorry, yes it is.

Still that is a bit complicated process:
a) There has to be a static site generated as a branch.
b) The static site is again generated in the dev site.

This kind of process has a great potential to confuse people and search engines.

[mariobehling]

What are the options to generate the site directly from a Readme.md and /docs branch of repositories?

[yukiisbored]

@mariobehling You can use static page generators like Jekyll, Pelican, etc or Sphinx which is made for documentation. The reason why it's designed this way is because the documentation are expected to be stored as Github pages.