Writting docs

README.md

@@ -4,7 +4,7 @@
 [![codecov](https://codecov.io/gh/bluekiri/anomalydetection/branch/master/graph/badge.svg)](https://codecov.io/gh/bluekiri/anomalydetection)
 [![All Contributors](https://img.shields.io/badge/all_contributors-4-blue.svg)](#contributors)
 
-![N|Bluekiri](var/bluekiri_logo.png?raw=true "Bluekiri")
+![N|Bluekiri](var/bluekiri_logo.png "Bluekiri")
 
 ## Overview
 
@@ -199,7 +199,7 @@ already implemented. In future it will hold a configurable, by user, dashboard.
 
 Then it has a signal list and its detail.
 
-![N|Dashboard](var/dashboard.png?raw=true "Dashboard")
+![N|Dashboard](var/dashboard.png "Dashboard")
 
 ### Use as Framework
 

doc/source/anomalydetection.rst → doc/source/api-reference.rst

@@ -1,5 +1,5 @@
-Source documentation
-====================
+API Reference
+=============
 
 .. toctree::
    :maxdepth: 4

doc/source/conf.py

@@ -47,7 +47,8 @@
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
-    'sphinx.ext.viewcode'
+    'sphinx.ext.viewcode',
+    'sphinx_markdown_tables',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -57,7 +58,12 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
+
+# Source parsers
+source_parsers = {
+   '.md': 'recommonmark.parser.CommonMarkParser',
+}
 
 # The master toctree document.
 master_doc = 'index'

doc/source/index.rst

@@ -1,17 +1,65 @@
-.. anomalydetection documentation master file, created by
-   sphinx-quickstart on Thu Jul  5 11:35:55 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to anomalydetection's documentation!
 ============================================
 
+.. image:: var/bluekiri_logo.png
+   :width: 200
+
+.. warning::
+   Anomaly Detection Framework is under an early development phase. API,
+   architecture and implementations could suffer important changes.
+   For this, Bluekiri do not offer any type of warranty. Use at your
+   **own responsibility**.
+
+Status
+******
+
+.. image:: https://travis-ci.org/bluekiri/anomalydetection.svg?branch=master
+   :target: https://travis-ci.org/bluekiri/anomalydetection
+.. image:: https://codecov.io/gh/bluekiri/anomalydetection/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/bluekiri/anomalydetection
+.. image:: https://img.shields.io/badge/all_contributors-4-blue.svg
+
+Overview
+********
+
+This project born from the need of detect anomalies on multiple and completely
+different signals, and react to it rapidly. To achieve this, Bluekiri decided to
+implement its own system to manage multiple signals at the same time in a easy
+and scalable way.
+
+This project is not focused on Machine Learning models, but in an effective
+Framework to put those models in production.
+
+Features
+********
+
+* It has an abstraction layer to implement engines, streaming sources and sinks,
+  repository sources and sinks.
+
+* It supports Kafka and PubSub by default.
+
+* It has a default implementation for that supports tumbling window aggregation
+  on Spark, on Kafka and PubSub sources using an specific JSON schema messages.
+
+* Settings are in YAML format.
+
+* It also includes a dashboard to visualize the signal anomalies and play with
+  signals in a sandbox to try models, tune parameters an see which parameters
+  fits better into your signal.
+
+.. image:: var/dashboard.png
+
+.. note::
+   The Sandbox is limited to use the included message handlers and models only.
+   Custom models will be available to use after we implement the plugin system.
+
 .. toctree::
    :maxdepth: 4
-   :caption: Contents:
-
+   :caption: Content
 
-   anomalydetection.rst
+   project
+   license
+   api-reference
 
 Indices and tables
 ==================