@peter/doc (#14)

* add documentation

.bookignore

@@ -0,0 +1,2 @@
+inabox/*
+

README.md

@@ -1,31 +1,74 @@
-# Deployment
+# 0GDA
 
-## Prerequisites
+## Overview
 
-- For local test environment, [aws-cli](https://aws.amazon.com/cn/cli/) is required.
+0GDA is a decentralized data availability (DA) service with deep consideration in security, scalability and decentralization. It is also the first DA solution with a built-in data storage layer. Users interact with ZeroGDA to submit and store their data into [0G Storage](https://github.com/0glabs/0g-storage-client) for later retrieval.
+
+To dive deep into the technical details, continue reading [0GDA protocol spec](docs/).
+
+## Integration
+
+Check out [this example](https://github.com/0glabs/0g-da-example-rust) for how to integrate the 0GDA into your own applications.
+
+For detailed public APIs, visit [gRPC API](docs/api/) section.
+
+## Deployment
+
+* For local test environment, [aws-cli](https://aws.amazon.com/cli/) is required.
+* [Local Stack setup](./#localstack)
+* [Disperser](./#disperser)
+* [Retriever](./#retriever)
+
+### LocalStack
 
-## LocalStack
 Create LocalStack(local aws simulation) docker image and start a docker instance:
+
 ```bash
 cd inabox
 
 make deploy-localstack
 ```
 
-## Disperser
-Build binaries:
+### Disperser
+
+1. Build binaries:
+
 ```
 cd disperser
-
 make build
 ```
-Run encoder:
+
+2. Run encoder:
+
 ```
 make run_encoder
 ```
-Set the cli arguments of run_batcher in Makefile to proper values, then run batcher and server:
+
+3. Set the cli arguments of run\_batcher in Makefile to proper values. Full list of available configuration parameters are showing below.
+
+4. Then run batcher and the main disperser server:
+
 ```
 make run_batcher
 
 make run_server
-```
+```
+
+### Retriever
+
+1. Build binaries:
+
+```
+cd retriever
+make build
+```
+
+2. Run the main retriever server:
+
+```
+make run
+```
+
+## Contributing
+
+To make contributions to the project, please follow the guidelines [here](contributing.md).

SUMMARY.md

@@ -0,0 +1,21 @@
+# Table of contents
+
+* [0GDA](README.md)
+* [0G DA Spec](docs/README.md)
+  * [Introduction](<docs/introduction.md>)
+  * [Architecture](<docs/architecture/README.md>)
+    * [Disperser](<docs/architecture/disperser.md>)
+    * [Batcher](<docs/architecture/batcher.md>)
+    * [Retriever](<docs/architecture/retriever.md>)
+  * [Security Guarantee](<docs/security/README.md>)
+    * [Encoding](<docs/security/encoding.md>)
+    * [KZG Encoder Backend](<docs/security/kzg.md>)
+  * [Data Model](<docs/data-model.md>)
+  * [gRPC API](<docs/api/README.md>)
+    * [Disperser API](<docs/api/disperser.md>)
+    * [Retriever API](<docs/api/retriever.md>)
+  * [Dependent Package](<docs/pkg/README.md>)
+    * [Encoding](<docs/pkg/encoding.md>)
+    * [KZG and FFT utils](<docs/pkg/kzg.md>)
+  * [Glossary](<docs/glossary.md>)
+* [Contributing](contributing.md)