X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=doc%2Findex.rst;h=f682640e96405fc19785ce1833f9d5626c38e064;hb=bff33deb2f6e23a6b04d7d0db037c10a7bb758ac;hp=7149b2bdfdbcb484e0f1d9600e072739948c2bf7;hpb=7c9fa49a18b09c3480314d29564f517e88de201f;p=xnet diff --git a/doc/index.rst b/doc/index.rst index 7149b2b..f682640 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 `_. -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