Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

Where is the documentation?

Miquel Sabaté Solà edited this page Nov 16, 2018 · 2 revisions

We have two sources for our documentation and they are used for two conceptually different things.

The wiki

First of all, we have this wiki. We use Github's wiki capabilities to document anything that is only relevant for development purposes.

Github pages

We make use of Github pages in order to showcase Portus and hold all the user documentation. The development of this is tracked in our site-source branch. You can find the end result here. We use this branch instead of the gh-pages branch directly because we make use of some custom Jekyll plugins which are not allowed to run on Github pages. Thus, we maintain all the documentation on site-source and then we deploy it into the gh-pages later on.