aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorWill Kahn-Greene <willg@bluesock.org>2011-04-09 18:43:26 -0400
committerWill Kahn-Greene <willg@bluesock.org>2011-04-09 18:44:50 -0400
commit8736b05d051dc5f2777dc4f86e684e3a3cec6a7c (patch)
tree3a0ac8ade22fea80531c8603588fc927802f2842 /docs/index.rst
parentb0de01cf0102ec596c2bdec553eb73713e9da103 (diff)
downloadmediagoblin-8736b05d051dc5f2777dc4f86e684e3a3cec6a7c.tar.lz
mediagoblin-8736b05d051dc5f2777dc4f86e684e3a3cec6a7c.tar.xz
mediagoblin-8736b05d051dc5f2777dc4f86e684e3a3cec6a7c.zip
Fleshes out documentation.
use, what their function is, and urls for library documentation * adds a forward chapter which talks about the documentation * adds an installation stub * adds a software stack chapter that covers what libraries are in * adds a design decisions chapter which covers why we chose the libraries and architecture
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 94f6c7f7..6f96ff8c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,11 +6,24 @@
Welcome to GNU MediaGoblin's documentation!
===========================================
+This documentation covers the GNU MediaGoblin software. It is versioned
+alongside the code and the source for this documentation is located in
+the mediagoblin repository in the ``docs/`` directory.
+
+It is also viewable on the Web site in HTML form.
+
+
Contents:
.. toctree::
:maxdepth: 2
+ foreward
+ softwarestack
+ installation
+ designdecisions
+
+
Indices and tables
==================