aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/index.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-10-07 08:55:35 -0400
committerMarti Bolivar <mbolivar@mit.edu>2010-10-07 08:55:35 -0400
commit4ed840601975a497a57c958b3d9043c21ddf2430 (patch)
tree2ef2a15c7d968b67bf1aafec9f5f053a60a6630c /docs/source/index.rst
parente14e95941120eb62ac22b9c9b9284048e4efd12d (diff)
downloadlibrambutan-4ed840601975a497a57c958b3d9043c21ddf2430.tar.gz
librambutan-4ed840601975a497a57c958b3d9043c21ddf2430.zip
some comment stubs
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst19
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 0bf6b5a..92b2d5d 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -3,18 +3,29 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to libmaple's documentation!
-====================================
+Maple Documentation Index
+=========================
-Contents:
+Welcome! This is the documentation index for programming your Maple.
+It contains technical documentation, as well as some getting started
+guides and example projects.
+
+.. TODO add projects
+
+Parts of the documentation:
.. toctree::
:maxdepth: 2
+ Language reference <language>
+ Library reference <libraries>
+ Unix toolchain <unix-toolchain>
+ libmaple (C library) API <libmaple>
+ Maple bootloader <bootloader>
+
Indices and tables
==================
* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search`