Improve docs.
[xnet] / doc / index.rst
index 7149b2b..f682640 100644 (file)
@@ -8,15 +8,42 @@ Plat/al 2
 
 Plat/al 2 is the second version of the plat/al (platform for alumni) developed by Polytechnique.org.
 
-It relies on Django.
+It relies on `the Django framework <http://www.djangoproject.com>`_.
 
 
-Contents:
+This documentation mostly focuses on developer setup, conventions, code architecture.
+
+Getting started
+---------------
+
+If you're new to the project, the following documents should help understanding and contributing:
+
+- :doc:`setup`: How to setup your development environment
+- :doc:`coding_rules`: Coding style in use in the project
+- :doc:`architecture`: General architecture and code layout
+- :doc:`tools`: Common tools used during development
+
+
+Design docs
+-----------
+
+Those documents describe the design and thoughts about various core parts of plat/al:
+
+- :doc:`events`: Managing events, registrations, prices
+
+
+Contents
+--------
 
 .. toctree::
    :maxdepth: 2
 
    setup
+   coding_rules
+   architecture
+   tools
+
+   events
 
 
 Indices and tables