refine structure

Author: mhchia

docs/_intro_old.md

@@ -2,6 +2,7 @@
   "label": "Getting Started",
   "position": 3,
   "link": {
-    "type": "generated-index"
+    "type": "generated-index",
+    "slug": "/getting-started"
   }
 }

docs/getting-started/_category_.json

@@ -1,12 +1,12 @@
 ---
-title: "Client"
-sidebar_position: 1
+title: "Sharing data and querying results"
+sidebar_position: 2
 ---
 
 # Client CLI
 Client CLI provides the following functionalities:
 
-- Sharing ETH Balance 
+- Sharing ETH Balance
 
   You can anonymously share your ETH balance at Binance
 
@@ -88,7 +88,7 @@ Note: The binaries are built directly from the source code using public GitHub w
        1. Execute `Client CLI`:
           ```bash
           poetry run client-share-data <eth-address> <binance-api-key> <binance-api-secret>  --notary-crt-path $(pwd)/notary.crt
-          ``` 
+          ```
      - Multi-Server Configuration
        1. Follow the instructions in Client CLI Configuration to create a `.env.client_cli` in the repository root directory
 

docs/getting-started/deployment/client.md docs/getting-started/client.mddocs/getting-started/deployment/client.md renamed to docs/getting-started/client.md

@@ -1,8 +1,8 @@
 ---
-sidebar_position: 1
+sidebar_position: 2
 ---
 
-# Customizing the Infrastructure
+# Customization
 
 Developers can modify and extend the boilerplate to create their own privacy-preserving applications by customizing these following components:
 
@@ -28,7 +28,7 @@ Here is the main file for creating proof, where you can make this following cust
 - Specify "public" parts of the received message.
   We specify the part that we want to make it publicly shown in the proof (recv_public_ranges), by specifying the regex that must be "redacted" & "private"
 
-- Specify "private" parts of the received message.  
+- Specify "private" parts of the received message.
   We specify the private part (recv_private_ranges)that will be accompanied with sha3 commitment in the proof while being censored from the proof itself by specifying our preferred regex. In Binance example, we specify to make ETH free balance of only 2 decimlals precision private.
 
 > With this structure, there will be some parts of received message that is not in either recv_public_ranges or recv_private_ranges. Those will be just redacted data that are censored without its correponding commitment (like in original TLSNotary)
@@ -61,4 +61,14 @@ This customization is to make sure we properly handle what data is allowed to pa
   Just modify the code [here](https://github.com/ZKStats/mpc-demo-infra/blob/e73b35aa487b8dc1efd403edddb80f10ebebf681/mpc_demo_infra/coordination_server/routes.py#L142-L157)
 - Modify how to process database i.e. creating task for sharing data MPC [here](https://github.com/ZKStats/mpc-demo-infra/blob/e73b35aa487b8dc1efd403edddb80f10ebebf681/mpc_demo_infra/coordination_server/routes.py#L233-L250)
 
-## 4. Deploy and test the customized application locally before scaling to a remote setup.
+## 4. Test locally
+
+To quickly check that your infrastructure customization is working as intended, you can run the integration tests as follows:
+
+```bash
+poetry run pytest -s tests/test_integration.py
+```
+
+## 5. Deploy the application locally/remotely
+
+To deploy the application locally, you can follow the steps in the [Deployment](/getting-started/deployment) section.

docs/getting-started/customization.md

@@ -1,7 +1,9 @@
 {
-  "label": "Deploying the Infrastructure",
+  "label": "Deploying Infrastructure",
+  "position": 1,
   "link": {
-    "type": "generated-index"
+    "type": "generated-index",
+    "slug": "/getting-started/deployment"
   }
 }
 

docs/getting-started/deployment/_category_.json

@@ -5,18 +5,18 @@ sidebar_position: 3
 # Configuration
 
 ## Default Configuration
-- [Coordination Server](https://github.com/exfinen/mpc-demo-infra/blob/main/mpc_demo_infra/coordination_server/config.py)
-- [Computation Party Server](https://github.com/exfinen/mpc-demo-infra/blob/main/mpc_demo_infra/computation_party_server/config.py)
-- [Data Consumer API Server](https://github.com/exfinen/mpc-demo-infra/blob/main/mpc_demo_infra/data_consumer_api/config.py)
-- [Client CLI](https://github.com/exfinen/mpc-demo-infra/blob/main/mpc_demo_infra/client_cli/config.py)
+- [Coordination Server](https://github.com/ZKStats/mpc-demo-infra/blob/main/mpc_demo_infra/coordination_server/config.py)
+- [Computation Party Server](https://github.com/ZKStats/mpc-demo-infra/blob/main/mpc_demo_infra/computation_party_server/config.py)
+- [Data Consumer API Server](https://github.com/ZKStats/mpc-demo-infra/blob/main/mpc_demo_infra/data_consumer_api/config.py)
+- [Client CLI](https://github.com/ZKStats/mpc-demo-infra/blob/main/mpc_demo_infra/client_cli/config.py)
 
 ## Overriding Default Configuration
 You can create the following configuration files at the repository root to override the default configuration.
 
 | Server | Configuration File Name | Example |
 | --- | --- | --- |
-| Coordination Server | `.env.coord` | [.env.coord](https://github.com/exfinen/mpc-demo-infra/blob/main/.env.coord.example) |
-| Computation Party Server | `.env.party` | [.env.party](https://github.com/exfinen/mpc-demo-infra/blob/main/.env.party.example) |
-| Data Consumer API Server | `.env.consumer_api` | [.env.consumer_api](https://github.com/exfinen/mpc-demo-infra/blob/main/.env.consumer_api.example) |
-| Client CLI | `.env.client_cli` | [.env.client_cli](https://github.com/exfinen/mpc-demo-infra/blob/main/.env.client_cli.example) |
+| Coordination Server | `.env.coord` | [.env.coord](https://github.com/ZKStats/mpc-demo-infra/blob/main/.env.coord.example) |
+| Computation Party Server | `.env.party` | [.env.party](https://github.com/ZKStats/mpc-demo-infra/blob/main/.env.party.example) |
+| Data Consumer API Server | `.env.consumer_api` | [.env.consumer_api](https://github.com/ZKStats/mpc-demo-infra/blob/main/.env.consumer_api.example) |
+| Client CLI | `.env.client_cli` | [.env.client_cli](https://github.com/ZKStats/mpc-demo-infra/blob/main/.env.client_cli.example) |
 

docs/getting-started/deployment/configuration.md

@@ -0,0 +1,8 @@
+{
+  "label": "Locally",
+  "link": {
+    "type": "generated-index",
+    "slug": "/getting-started/deployment/servers/local"
+  }
+}
+

docs/getting-started/deployment/local/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "To remote servers",
+  "link": {
+    "type": "generated-index",
+    "slug": "/getting-started/deployment/remote"
+  }
+}
+