[DOCS] Added a draft of the documentation index file

s-kostyuk · Sep 11, 2017 · a01b9aa · a01b9aa
1 parent d24acdd
commit a01b9aa
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 3 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,14 +3,54 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to ADPL's documentation!
-================================
+Codename: Everthing Platform
+============================
 
-Contents:
+Everthing Platform is an open-source IoT-enabled automation platform.
+It allows to operate different types of devices, set-up automation 
+rules (if-this-than-that), store and process a history of events and
+all of that autonomously from cloud services and Internet connection
+(if you want it).
+
+Documentation on Everthing Platform is slitted into a couple of sections:
+
+* :ref:`user-docs`
+* :ref:`api-docs`
+* :ref:`dev-docs`   
+
+Platform itself is hosted on GitHub: https://github.com/s-kostyuk/adpl/
+
+.. toctree::
+   :maxdepth: 2
+   :caption: User Documentation
+   :name: user-docs
+
+   user/getting_started
+   user/installation
+   user/first_run
+   user/configuration
+   user/integrations
+   user/discovery
+   user/client_applications
+
+.. toctree::
+   :maxdepth: 2
+   :caption: External API Documentation
+   :name: api-docs
+
+   user/api_types
+   user/rest_api
+   user/streaming_api
 
 .. toctree::
    :maxdepth: 2
+   :caption: Developer Documentation
+   :name: dev-docs
 
+   dev/dev_overview
+   dev/base_components
+   dev/dev_integrations
+   dev/implement_own_integration
 
 
 Indices and tables

diff --git a/docs/source/user/getting_started.rst b/docs/source/user/getting_started.rst
@@ -0,0 +1,5 @@
+Getting Started
+===============
+
+Test
+
diff --git a/docs/source/user/installation.rst b/docs/source/user/installation.rst
@@ -0,0 +1,2 @@
+Installation
+============