Browse Source

Some basic doc's index with todo lists. #220

Rafał Pitoń 11 years ago
parent
commit
e9cef8957d
1 changed files with 17 additions and 14 deletions
  1. 17 14
      docs/index.rst

+ 17 - 14
docs/index.rst

@@ -1,22 +1,25 @@
-.. Misago documentation master file, created by
+====================
-   sphinx-quickstart on Fri Jan 10 02:31:11 2014.
+Misago Documentation
-   You can adapt this file completely to your liking, but it should at least
+====================
-   contain the root `toctree` directive.
 
 
-Welcome to Misago's documentation!
+Welcome to Misago documentation!
-==================================
 
 
-Contents:
+.. warning::
+   Works on documentation only recently have begun and are currently focused exclusively on developer oriented subjects.
 
 
-.. toctree::
+Setup and Maintenance
-   :maxdepth: 2
+=====================
 
 
+(Documents about low level configuration (settings.py), available cron tasks, filestytem, installing, updating)
 
 
 
 
-Indices and tables
+Customising Appearance
-==================
+======================
 
 
-* :ref:`genindex`
+Changing templates and assets (images, js, css), using pipeline, templates reference and coding guidelines for templates, css i js
-* :ref:`modindex`
-* :ref:`search`
 
 
+
+Writing New Code
+================
+
+Coding guidelines for python files, links to Django doc's explaining their features, Misago API's and hooks references