Feat/gitbook

README.md

@@ -1,59 +1,28 @@
-<h1 align="center">Welcome to @dataswapcore/docs 👋</h1>
-<p>
-  <a href="https://github.com/dataswap/docs#readme" target="_blank">
-    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
-  </a>
-  <a href="https://github.com/dataswap/docs/graphs/commit-activity" target="_blank">
-    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
-  </a>
-  <a href="https://github.com/dataswap/docs/blob/master/LICENSE" target="_blank">
-    <img alt="License: MIT and APACHE " src="https://img.shields.io/badge/License-MIT and APACHE -yellow.svg" />
-  </a>
-</p>
+---
+description: An overview to Dataswap
+---
 
-### 🏠 [Homepage](https://github.com/dataswap/docs)
-
-## Dataswap
+# Intrduction
 
 Dataswap is a blockchain-based Layer 2 project built on [IPFS](https://ipfs.tech/) and [Filecoin](https://filecoin.io/), functioning as a decentralized open data exchange platform. Its goal is to aggregate open datasets from various regions and industries globally, enabling the permanent storage of valuable human data. Additionally, Dataswap offers comprehensive and reliable services for data retrieval, downloading, and analysis. Through these efforts, it aims to facilitate data sharing and collaborative progress for humanity.
 
-## Deployment
-
-### Clone the repository
-
-```shell
-git clone https://github.com/dataswap/docs.git
-cd docs/
-```
-
-### Build
-
-```shell
-npm install
-npm run docs:build
-```
-
-### Running locally
-
-```
-npm run docs:dev
-```
-
-## Author
-
-👤 **dataswap**
-
-- GitHub: [@dataswap](https://github.com/dataswap)
-
-## 🤝 Contributing
-
-Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/dataswap/docs/issues). You can also take a look at the [contributing guide](https://github.com/dataswap/docs/blob/master/CONTRIBUTING.md).
-
-## Show your support
-
-Give a ⭐️ if this project helped you!
-
-## 📝 License
-
-Copyright © 2023 [dataswap](https://github.com/dataswap).<br />
-This project is [MIT and APACHE ](https://github.com/dataswap/docs/blob/master/LICENSE) licensed.
+### Features
+
+Aggregating open big data from various global regions and industries, encompassing economic, financial, medical, and health data types. This creates efficient and valuable gateways to datasets.
+
+Implement a decentralized matching mechanism to attract more open dataset suppliers, storage providers, retrieval providers, compute providers, and users, fostering global data sharing and innovation.
+
+* `Dataswap storage`
+  * about [Discussion on Trustless Notary](https://docs.google.com/document/d/1KLR6nZ8ic4ARj3J46XsxSE\_b1RpDP\_z3JBKL4alHGGw/edit?pli=1) and [Trustless Notary Design Space + Guidelines](https://medium.com/filecoin-plus/ideation-trustless-notary-design-space-guidelines-bc21f6d9d5f2), [Dataswap storage](https://github.com/dataswap/specs/tree/main/systems#22-trustless-notary) has undertaken a more in-depth implementation in this regard.
+    * Enabling proof and verification of stored [Valid Data Consistency](https://github.com/dataswap/specs/blob/main/algorithms/README.md#2-dataset-consistency-algorithm).
+    * Monitoring client's valid data storage and verification with finer granularity.
+    * Simplifying notary work through code.
+    * Decoupling data cap and notary signatures to prevent malicious behavior.
+  * Utilizing a data authentication mechanism (including data submit, verification, and auditing) to ensure the genuine value of platform data.
+  * Utilizing the decentralized automated matching mechanism of DataSwap storage for the permanent storage ([using Filecoin](https://filecoin.io/)) and distribution of datasets, establishing a transparent and publicly accessible distributed data index.
+* `Dataswap retrieve`
+  * Provide open retrieval and download services. This includes various access methods such as web interfaces, API integration, and file downloads.
+    * Customers pay funds into smart contracts to easily search for and access the required datasets.
+    * Retrieval service providers receive incentives by offering retrieval services.
+* `Dataswap compute`
+  * Providing decentralized data analysis and matching services, empowering data-driven decision-making and intelligent solutions.

SUMMARY.md

@@ -0,0 +1,38 @@
+# Table of contents
+
+* [Intrduction](README.md)
+
+## Overview
+
+* [Role Definitions](overview/role-definitions.md)
+* [Process Overview](overview/process-overview.md)
+* [Dataset Consistency Algorithm](overview/dataset-consistency-algorithm.md)
+
+## Using Dataswap
+
+* [Dataset](using-dataswap/dataset/README.md)
+  * [Dataset Info](using-dataswap/dataset/dataset-info/README.md)
+    * [SubmitDatasetInfo](using-dataswap/dataset/dataset-info/submitdatasetinfo.md)
+    * [SubmitReplicasRule](using-dataswap/dataset/dataset-info/submitreplicasrule.md)
+  * [Dataset Proof](using-dataswap/dataset/dataset-proof/README.md)
+    * [Generate CAR File](using-dataswap/dataset/dataset-proof/generate-car-file.md)
+    * [Submit Dataset Proof](using-dataswap/dataset/dataset-proof/submit-dataset-proof.md)
+  * [Dataset Proof Challenge](using-dataswap/dataset/dataset-proof-challenge/README.md)
+    * [Submit Proof Challenge](using-dataswap/dataset/dataset-proof-challenge/submit-proof-challenge.md)
+  * [Dataset Dispute Challenge](using-dataswap/dataset/dataset-dispute-challenge/README.md)
+    * [Proof Dispute](using-dataswap/dataset/dataset-dispute-challenge/proof-dispute.md)
+    * [Challenge Dispute](using-dataswap/dataset/dataset-dispute-challenge/challenge-dispute.md)
+* [Matching](using-dataswap/matching/README.md)
+  * [Start Matching](using-dataswap/matching/start-matching.md)
+  * [bidding](using-dataswap/matching/bidding.md)
+* [Storage](using-dataswap/storage/README.md)
+  * [Datacap](using-dataswap/storage/datacap/README.md)
+    * [Datacap Pool](using-dataswap/storage/datacap/datacap-pool.md)
+    * [DatacapChunkLand Collateral](using-dataswap/storage/datacap/datacapchunkland-collateral.md)
+  * [Storage Provider](using-dataswap/storage/storage-provider.md)
+* [Community Governance](using-dataswap/community-governance.md)
+
+## Network
+
+* [Calibration Network Contract](network/calibration-network-contract.md)
+* [Main Network Contract](network/main-network-contract.md)