wip document structure

algorand · Feb 4, 2020 · ee45109 · ee45109
1 parent 482dd31
commit ee45109
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 3 deletions.
diff --git a/docs/API.rst b/docs/API.rst
@@ -0,0 +1,4 @@
+.. _API:
+
+API Reference
+=============
diff --git a/docs/accessing_transaction_field.rst b/docs/accessing_transaction_field.rst
@@ -0,0 +1,2 @@
+Acessing Transaction Field
+==========================
diff --git a/docs/arithmetic_expression.rst b/docs/arithmetic_expression.rst
@@ -0,0 +1,2 @@
+Arithmetic Expression
+=====================
diff --git a/docs/atomic_transfer.rst b/docs/atomic_transfer.rst
@@ -0,0 +1,2 @@
+Atomic Transfer
+===============
diff --git a/docs/control_structures.rst b/docs/control_structures.rst
@@ -0,0 +1,2 @@
+Control Structures
+==================
diff --git a/docs/data_type.rst b/docs/data_type.rst
@@ -0,0 +1,5 @@
+Data Type
+=========
+
+
+
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,2 @@
+PyTeal Examples
+===============
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,13 +3,43 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-.. mdinclude:: ../README.md
+PyTeal: Algorand Smart Contracts in Python
+==========================================
+
+PyTeal is a Python language binding for `Algorand Smart Contracts (ASC1s)<https://developer.algorand.org/docs/asc>`_. 
+
+Algorand Smart Contracts are implemented using a new language that is stack-based, 
+called `Transaction Execution Approval Language (TEAL)<https://developer.algorand.org/docs/teal>`_. 
+This a non-Turing complete language that allows branch forwards but prevents recursive logic 
+to maximize safety and performance. 
+
+However, TEAL is essentially an assembly language.
+With PyTeal, developers can express smart contract logic purely using Python. 
+PyTeal provides higher level, functional programming style abstactions over TEAL
+and does type checking at construction time.
+
+PyTeal **hasn't been security audited**. Use it at your own risk.
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
+   :caption: Getting Started
+
+   overview
+   installation
+   examples
 
+.. toctree::
+   :maxdepth: 1
+   :caption: User Guide
 
+   data_type
+   arithmetic_expression
+   accessing_transaction_field
+   atomic_transfer
+   control_structures
+   API
+   using_pyteal_with_sdk
+
 
 Indices and tables
 ==================

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,2 @@
+Install PyTeal
+==============
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -0,0 +1,2 @@
+Overview
+========
diff --git a/docs/using_pyteal_with_sdk.rst b/docs/using_pyteal_with_sdk.rst
@@ -0,0 +1,3 @@
+Using PyTeal With Algorand Python SDK
+=====================================
+