Developer and User Documentation

This page is a place to organize our documentation plans. We are trying to get three different documentations ready for 0.2, one of which is more a FAQ than a documentation. See also Zine Documentation Project

Developer Documentation

This is the simple one. We grab ourselves a recent Sphinx version and start building up a simple developer documentation. The developer documentation will be unversioned but have "new in / changed in" markers to let developers know when a feature was introduced or changed. The developer documentation is English only and integrated into the Zine website. Additionally it's distributed as as raw Sphinx folder with the tarballs / zip archives but not built.

User Documentation

The user documentation is translated and integrated into the help section of the admin panel. We do *not* offer the documentation for download in the Zine website and there are no separate builds for the user outside of the admin panel. Later this may change, but for the moment it's unnecessary extra work we can avoid. Installation Instructions / Troubleshooting

Because user documentation requires a running Zine system it's a bad location for installation instructions and troubleshooting. Because of this we will have that part of the user documentation as translated documents located on the Zine website. The english version will be next to the download page, the translated at zine.pocoo.org/$language_code. The latter page will be the default page the user is redirected to when visiting zine.pocoo.org and his user agent language is set to $language_code. This page has the links to the troubleshooting pages, installation instructions and where to download zine together with a button to the english pages on the website.