fuel/depot — Issue #1: Development Documentation
Author: WanWizard
Created: 2012-02-09 17:45:46+00:00
State: open
Labels: Feature request, Pending

The application needs an interface through which the development documentation can be managed.

Current plan is to use:
- markdown for documentation text
- form-based entry for class and method documentation (forces a strict format)
- ? a special markdown command to insert a class::method docblock in the generated html
- version control on documentation
- moderation, with ability to delete or rollback versions
- release docs = a snapshot of all versions on a specific timestamp

Docs require user based access for modifcations, based on group membership with ACL's for 'no access', 'moderated access', or 'full access'.

A task should be written which will generate an HTML version of the docs, which can be used off-line, similar to the current documentation. It can also be zipped and presented for download on the main website.