chore: add docs folder

Author: satello

README.md

@@ -1,25 +1,9 @@
 # Archon
 
-<p align="center">  
-  <a href="https://badge.fury.io/js/%40kleros%2Farchon"><img src="https://badge.fury.io/js/%40kleros%2Farchon.svg" alt="npm version"></a>
-  <a href="https://travis-ci.org/kleros/archon"><img src="https://travis-ci.org/kleros/archon.svg?branch=master" alt="Build Status"></a>
-  <a href="https://david-dm.org/kleros/archon"><img src="https://david-dm.org/kleros/archon.svg" alt="Dependencies"></a>
-  <a href="https://david-dm.org/kleros/archon?type=dev"><img src="https://david-dm.org/kleros/archon/dev-status.svg" alt="Dev Dependencies"></a>
-  <a href="https://github.com/facebook/jest"><img src="https://img.shields.io/badge/tested_with-jest-99424f.svg" alt="Tested with Jest"></a>
-  <a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide"></a>
-  <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="Styled with Prettier"></a>
-  <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits"></a>
-  <a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen Friendly"></a>
-</p>
-
-> Archon provides functionality for Arbitrator and Arbitrable Ethereum smart contracts as defined in ERC 792.
+> Archon provides functionality for Arbitrator and Arbitrable Ethereum smart contracts as defined in ERC 792 and ERC 1497.
 
 ## Documentation
 
-Archon ^0.x works with Solidiy 0.4.x contracts but does not include the most recent features of web3.
-
-Archon ^1.x DOES NOT work with Solidity 0.4.x
-
 See full documentation at https://archon.readthedocs.io/en/latest/index.html
 
 ## Installation
@@ -33,7 +17,7 @@ npm install @kleros/archon
 ```
 var Archon = require('@kleros/archon');
 
-var archon = new Archon('ws://some.local-or-remote.node:8546');
+var archon = new Archon('wss://some.local-or-remote.node:8546');
 
 > archon.arbitrator
 > archon.arbitrable
@@ -53,3 +37,26 @@ yarn test
 ```sh
 yarn run build
 ```
+
+## Update Docs
+
+The documentation is based on Sphinx. Install Sphinx with your global python or in a virtualenv
+```
+pip install sphinx
+```
+
+
+1) Update `.rst` files in /docs
+
+
+2) Run to generate new docs bundle
+```
+cd docs && make html
+```
+
+3) View changes
+```
+open ./docs/_build/html/index.html
+```
+
+4) Push changes

docs/_build/doctrees/archon-arbitrable.doctree

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 4ec0f31f8e54a4abb502558368ea861c
+config: 75f5eab7a3edd5571381df83423030bb
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/doctrees/archon-arbitrator.doctree

@@ -1,2 +1,2 @@
 
-.. note:: Archon depends on Web3 1.0. This version of ``web3`` is still in Beta so usage may change unexpectedly and/or bugs may arise until a stable version of Web3 1.0 is released.
+.. note::

docs/_build/doctrees/archon-utils-validation.doctree

@@ -19,11 +19,8 @@ To get up to speed on the standards please reference:
 `ERC 1497 Evidence Standard
 <https://github.com/ethereum/EIPs/issues/1497>`_.
 
-`Implementation of an Arbitrable Contract
-<https://github.com/kleros/kleros-interaction/blob/master/contracts/standard/arbitration/Arbitrable.sol/>`_.
-
-`Implementation of an Arbitrator Contract
-<https://github.com/kleros/kleros-interaction/blob/master/contracts/standard/arbitration/Arbitrator.sol/>`_.
+`Tutorials on how to use ERC-792 and ERC-1497
+<https://erc-792.readthedocs.io>`_.
 
 .. toctree::
    :maxdepth: 2

docs/_build/doctrees/archon-utils.doctree

@@ -11,17 +11,17 @@ MetaEvidence Dynamic Scripts
 dynamicScriptURI as specified in `ERC 1497 <https://github.com/ethereum/EIPs/issues/1497>`_. allow
 for metaEvidence to be changed dynamically.
 
-In order to support asynchronous scripts Archon provides global ``scriptResolver`` and ``scriptRejecter``. Please use these
+In order to support asynchronous scripts Archon provides global functions ``resolveScript`` and ``rejectScript``. Please use these
 when you are returning the updates to the metaEvidence
 
 Available Global Variables
 ==========================
 
 When you create a script you can assume that you will have global access to these variables:
 
-1) ``scriptResolver`` - ``function``: Call this function to return the result of your script.
+1) ``resolveScript`` - ``function``: Call this function to return the result of your script.
 
-2) ``scriptRejecter`` - ``function``: To throw a handled error in your script you can call scriptRejecter.
+2) ``rejectScript`` - ``function``: To throw a handled error in your script you can call scriptRejecter.
 
 3) ``scriptParameters`` - ``object``: These are the parameters you pass as `options["scriptParameters"]` in :ref:`getMetaEvidence <archon.arbitrable.getMetaEvidence>`
 
@@ -40,11 +40,11 @@ Example
           ... async code to lookup data here ...
 
           if (data) {
-            scriptResolver({
+            resolveScript({
               newMetaEvidenceParam: "Look at me!"
             })
           } else {
-            scriptRejecter("Unable to fetch data")
+            rejectScript("Unable to fetch data")
           }
         }