Merge pull request #67 from codersquid/newdocs

A start at updating the documentation

docs/content.rst

@@ -0,0 +1,40 @@
+Content Management
+==================
+
+The content management system allows organizers to create pages and page
+sections for a conference.  You may want to have an entire page about a job
+fair, or may only want to have an editable section at the top of a tutorial
+schedule with some instructions for all of the tutorial attendees.
+
+CMS App
+-------
+
+The ``cms`` app provides functionality for creating wiki pages. These pages can
+be created using the django admin. The django admin form has controls for
+specifying:
+
+* title
+* markup content
+* url path
+* tags
+* public or draft mode
+* publication date
+
+Page content and title can also be edited directly at the url. The ``cms`` app
+uses the `django-reversion <http://django-reversion.readthedocs.org>`_ package,
+thus content is version controlled.
+
+Boxes App
+---------
+
+The ``boxes`` app allows for sections of a page to be edited like a wiki. To use this in a template
+use the ``boxes_tags`` and specify a box section of a page using the ``boxes`` tag:
+
+.. code-block:: django
+
+    {% load boxes_tags %}
+    {% boxes "intro_section" %}
+
+This template will render an editable content box. When a staff user visits the
+page,  they will see an ``Edit this content`` button. The ``boxes`` app also uses the
+``django-reversion`` package.

docs/index.rst

@@ -1,27 +1,30 @@
 Pinax Symposion
 ===============
 
-Pinax Symposion is an open-source Django project for conference websites.
+Pinax Symposion is an open-source conference management system written in
+Django.  Symposion includes support for content management, proposal
+submission, reviews, scheduling and sponsor management.
 
-It came out of development done by Eldarion for DjangoCon US and US PyCon
-but has been independently used for a number of other conferences.
-
-We are in the process of cleaning things up and making them more generic.
-
-The project homepage is http://eldarion.com/symposion/
-
-Apps:
 
 .. toctree::
    :maxdepth: 2
-   
+
+   project
    conference
+   content
+   proposals
    sponsorship
    speakers
-   proposals
    schedule
 
 
+About
+-----
+
+Symposion came out of development done by Eldarion for DjangoCon US and US PyCon
+but has been independently used for a number of other conferences.
+The project homepage is http://eldarion.com/symposion/
+
 Indices and tables
 ==================
 

docs/project.rst

@@ -0,0 +1,10 @@
+Project Template
+================
+
+The `pinax-project-symposion <https://github.com/pinax/pinax-project-symposion>`_ repository
+is a starter project demonstrating how to create a minimal symposion instance.
+
+TODO:
+  * initial data
+  * overriding templates
+  * deployment