aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst86
1 files changed, 86 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..5c1718f
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,86 @@
+.. _index:
+
+Maple Documentation Contents
+============================
+
+Welcome! This is the Maple documentation index. If you just bought a
+Maple, you probably want to head to the :ref:`quickstart
+<maple-quickstart>`. If you're having problems, check out the
+:ref:`troubleshooting <troubleshooting>` and :ref:`known problems
+<errata>` pages.
+
+Have fun!
+
+.. _index-usage:
+
+**Usage Guides:**
+
+.. toctree::
+ :maxdepth: 1
+
+ Quickstart <maple-quickstart>
+ IDE Installation <maple-ide-install>
+ IDE Usage <ide>
+ Command-Line Toolchain <unix-toolchain>
+
+.. _index-maple-programming:
+
+**Maple Programming:**
+
+.. toctree::
+ :maxdepth: 1
+
+ Language <language>
+ Libraries <libraries>
+ Arduino Compatibility <compatibility>
+ libmaple <libmaple>
+ External Interrupts <external-interrupts>
+ Bootloader <bootloader>
+ Troubleshooting <troubleshooting>
+ Known Problems <errata>
+
+.. _index-hardware:
+
+**Hardware Peripherals:**
+
+.. toctree::
+ :maxdepth: 1
+
+ adc
+ gpio
+ i2c
+ jtag
+ pwm
+ spi
+ timers
+ usb
+ usart
+
+.. _index-schematics:
+
+**Board Hardware Documentation:**
+
+.. toctree::
+ :maxdepth: 1
+
+ hardware/maple.rst
+
+.. TODO write/include these upon Mini and Native release
+
+.. toctree::
+ :hidden:
+
+ hardware/maple-mini.rst
+ hardware/maple-native.rst
+
+.. _index-reference:
+
+**Reference:**
+
+.. toctree::
+ :maxdepth: 1
+
+ Technical Specifications <specs>
+ Complete Language Index <language-index>
+
+