update readme & docs

README.rst

@@ -1,14 +1,24 @@
-RLTK
-****
+RLTK: Record Linkage ToolKit
+============================
 
-Record Linkage ToolKit (RLTK)
+.. begin-intro
 
 .. image:: https://readthedocs.org/projects/rltk/badge/?version=latest
     :target: http://rltk.readthedocs.io/en/latest/
     :alt: Documents
 
+The Record Linkage ToolKit (RLTK) is a general-purpose open-source record linkage platform that allows users to build powerful Python programs that link records (represented as arbitrarily structured JSON documents) referring to the same underlying entity. Record linkage is an extremely important problem that shows up in domains extending from social networks to bibliographic data and biomedicine. Current open platforms for record linkage have problems scaling even to moderately sized datasets, or are just not easy to use (even by experts). RLTK attempts to address all of these issues.
+
+RLTK supports a full, scalable record linkage pipeline, including multi-core algorithms for blocking, profiling data, computing a wide variety of features (including string, token, numeric, phonetic and time-series features), and training and applying machine learning classifiers based on Python’s sklearn library. An end-to-end RLTK pipeline can be jumpstarted with only a few lines of code. However, RLTK is also designed to be extensible and customizable, allowing users arbitrary degrees of control over many of the individual components. You can add new features to RLTK (e.g. a custom string similarity) very easily.
+
+Although easy to use, RLTK also contains advanced modules that allow you to automate record linkage by giving you access to state-of-the-art algorithms that were only published recently and have no other open-source implementations we are aware of. Some of these algorithms have been applied to extremely difficult domains such as Dark Web and human trafficking data. Last but not least, RLTK gives you easy facilities to convert your native data format (such as CSV, natural language documents, XML, RDF, graph formats etc.) into JSON so you have to invest minimal manual labor to get started.
+
+RLTK is under active maintenance and we expect to keep adding new features and state-of-the-art record linkage algorithms in the foreseeable future, in addition to continuously supporting our adopters to integrate the platform into their applications.
+
+.. end-intro
+
 Documentation
-=============
+-------------
 
 * `Tutorials <http://rltk.readthedocs.io>`_
-* `API Reference <http://rltk.readthedocs.io>`_
+* `API Reference <http://rltk.readthedocs.io/en/latest/modules.html>`_

docs/conf.py

@@ -89,11 +89,32 @@
 # documentation.
 #
 html_theme_options = {
-    'page_width': '1600px',
-    'sidebar_width': '300px',
+    'page_width': '1380px',
+    'sidebar_width': '220px',
     'github_user': 'usc-isi-i2',
     'github_repo': 'rltk',
     'github_banner': 'true',
+    'github_type': 'star',
+    'extra_nav_links': {
+        'RLTK @ GitHub': 'https://github.com/usc-isi-i2/rltk',
+        # 'RLTK @ PyPI': 'https://github.com/usc-isi-i2/rltk',
+        'Issue Tracker': 'https://github.com/usc-isi-i2/rltk/issues',
+        'USC/ISI-I2': 'http://usc-isi-i2.github.io/'
+    },
+    'show_powered_by': False
+}
+
+html_show_sourcelink = False
+
+html_sidebars = {
+    '**': [
+        'about.html',
+        'localtoc.html',
+        'navigation.html',
+        # 'relations.html',
+        'searchbox.html',
+        # 'donate.html',
+    ]
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/index.rst

@@ -3,15 +3,18 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-RLTK's documentation
-=====================
+RLTK: Record Linkage ToolKit
+============================
 
-Record Linkage ToolKit.
+.. include:: ./../README.rst
+      :start-after: begin-intro
+      :end-before: end-intro
 
-Getting Start
---------------
 
-Installation (need to upload to PYPI later)::
+Getting Started
+---------------
+
+Installation (need to upload to PyPI later)::
 
    pip install rltk