update

docs/contact.md

@@ -0,0 +1,11 @@
+---
+sidebar_label: "Contact"
+sidebar_position: 7
+---
+
+# Contact Us
+
+For feedback, bug report, request, or general Subnet discussion please feel free to make a post on [XDC Forum](https://forum.xinfin.org/) or [GitHub Issues](https://github.com/XinFinOrg/XDC-Subnet/issues)
+
+
+For troubleshooting, you can talk to us at [Telegram Support Group](./3_troubleshooting.md#telegram-troubleshooting-support-group) and we will check as soon as possible.

docs/deployment/1_launch_subnet.md

@@ -20,6 +20,8 @@ sidebar_position: 1
     - https://faucet.apothem.network/ 
     - https://faucet.blocksscan.io/
 
+## Video Walkthrough
+
 ## Generate Subnet Configs With UI
 
   1. Pull `generator.sh` script from the generator Github repo

docs/deployment/2_configs_explanation.md

@@ -19,30 +19,30 @@ After the generator has succesfully run, all generated files will be under 'gene
 - docker-compose.env - The config injection path that docker uses to point to other *.env files.
 
 ### common.env
-PARENTNET_URL - RPC of the parentnet
-SUBNET_URL - RPC of the Subnet
-PARENTNET_WALLET - Public key of the Relayer wallet
-PARENTNET_WALLET_PK - Private key of the Relayer wallet
-VITE_SUBNET_URL - URL of stats server backend that is passed to your local browser
-VITE_SUBNET_RPC - URL of the Subnet RPC that is passed to your local browser
-CHECKPOINT_CONTRACT - Checkpoint Smart Contract address
-STATS_SECRET - Secret used by stats server backend
-EXTIP - Configured IP of bootnode
-BOOTNODE_PORT - Configured port of bootnode
+- PARENTNET_URL - RPC of the parentnet
+- SUBNET_URL - RPC of the Subnet
+- PARENTNET_WALLET - Public key of the Relayer wallet
+- PARENTNET_WALLET_PK - Private key of the Relayer wallet
+- VITE_SUBNET_URL - URL of stats server backend that is passed to your local browser
+- VITE_SUBNET_RPC - URL of the Subnet RPC that is passed to your local browser
+- CHECKPOINT_CONTRACT - Checkpoint Smart Contract address
+- STATS_SECRET - Secret used by stats server backend
+- EXTIP - Configured IP of bootnode
+- BOOTNODE_PORT - Configured port of bootnode
 
 ### subnet*.env
-INSTANCE_NAME - Subnet node name
-PRIVATE_KEY - Subnet node private key
-BOOTNODES - Subnet bootnode to connect and discover other Subnet nodes
-NETWORK_ID - Subnet network ID
-SYNC_MODE - Node operation mode (full or archive)
-RPC_API - enabled api's scheme such as eth, xdpos, debug, net
-STATS_SERVICE_ADDRESS - Stats server backend URL
-STATS_SECRET - Secret to authenticate with Stats server
-PORT - Subnet node port for communication with other Subnet nodes
-RPCPORT - Subnet node port for accepting RPC calls
-WSPORT -  Subnet node port for accepting Websocket connections
-LOG_LEVEL - Desired logging level. 2=Warn, 3=Info, 4=Debug.
+- INSTANCE_NAME - Subnet node name
+- PRIVATE_KEY - Subnet node private key
+- BOOTNODES - Subnet bootnode to connect and discover other Subnet nodes
+- NETWORK_ID - Subnet network ID
+- SYNC_MODE - Node operation mode (full or archive)
+- RPC_API - enabled api's scheme such as eth, xdpos, debug, net
+- STATS_SERVICE_ADDRESS - Stats server backend URL
+- STATS_SECRET - Secret to authenticate with Stats server
+- PORT - Subnet node port for communication with other Subnet nodes
+- RPCPORT - Subnet node port for accepting RPC calls
+- WSPORT -  Subnet node port for accepting Websocket connections
+- LOG_LEVEL - Desired logging level. 2=Warn, 3=Info, 4=Debug.
 
 
 
@@ -57,7 +57,8 @@ LOG_LEVEL - Desired logging level. 2=Warn, 3=Info, 4=Debug.
 3. Stats Server (UI backend) - port 5213. 
 4. UI Frontend - port 5214.
 5. Relayer UI - port 5215.
-6. Generator UI - port 5210.
+6. Faucet Server - port 5211
+7. Generator UI - port 5210.
 <!-- 7. Explorer UI - port -->
 
 

docs/deployment/3_troubleshooting.md

@@ -5,9 +5,9 @@ sidebar_position: 3
 
 # Common Issues 
   - Subnet blocks are not being mined.
-    1. First confirm that the Subnet nodes are able to communicate with each other through the network layer. Run the check peer script `generated/scripts/check-peers.sh` the number of peers should be one less than number of subnet nodes.
+    1. First confirm that the Subnet nodes are able to communicate with each other through the network layer. Run the check peer script `generated/scripts/check-peers.sh` the number of peers should be one less than number of subnet nodes. For example, if there are 3 Subnet nodes in total, each node should have 2 peers.
 
-    2. If the nodes are peering but still not mining, it could be a low memory issue. In Docker configs you can try to increase memory or swap. Then, in case of fresh Subnet, delete data and start the nodes again. ![Docker Memory Config](./img/docker_mem.png) 
+    2. If the nodes are peering but still not mining, it could be a low memory issue. In Docker configs you can try to increase memory or swap. Then, in case of fresh Subnet, [delete data and start the nodes again](./1_launch_subnet.md/#deleting-subnet). ![Docker Memory Config](./img/docker_mem.png)
 
     3. Docker engine in Mac OS can be inconsistent after long-running or high-load. It could help to restart the machine and [hard reset the subnet](./1_launch_subnet.md#deleting-subnet ) to get it running.
 

docs/deployment/5_faq.md

@@ -1,6 +1,6 @@
 ---
-sidebar_label: "5. FAQ"
-sidebar_position: 5
+sidebar_label: "4. FAQ"
+sidebar_position: 4
 ---
 
 # Frequently Asked Questions
@@ -9,15 +9,14 @@ sidebar_position: 5
 
   Testnet, devnet will be less stable due to frequent development changes.
 
- - Where do I get Subnet tokens?
+ - Where are all the Subnet tokens, how do I use the Subnet?
 
-  In XDC-Subnet all initial tokens are assigned to the Grandmaster wallet (check keys.json). You can use any web3 wallet and connect to the Subnet RPC as a custom network, then transfer to other addresses.
+  In XDC-Subnet all initial tokens are assigned to the Grandmaster wallet (check keys.json). You can transfer them to any wallet address. Check [Faucet](../usage/2_faucet.md).
 
 - How can I manage Subnet tokens?
 
-  1. You can use any web3 wallet and connect to the Subnet RPC as a custom network, then transfer to other addresses.
-  2. We have a faucet script to help with one-time transfers under `generated/scripts/faucet.sh`
-  3. We have a faucet server so anyone can request for tokens, to deploy check `generated/scripts/faucet-server.sh`
+  1. Check [here](../usage/2_faucet.md) for how you can use the Subnet Faucet to easily transfer Subnet tokens to your users.
+  2. You can use any web3 wallet and connect to the Subnet RPC as a custom network, then transfer to other addresses.
 
  - How can I easily give out Subnet tokens to my users?
 
@@ -30,7 +29,7 @@ sidebar_position: 5
 
 - This function didn't work/I have encoutered an unexpected bug
 
-  Please report the issue via [Telegram Support Group](./3_troubleshooting.md#telegram-troubleshooting-support-group) and we will check as soon as possible.
+  For troubleshooting we can help you at [Telegram Support Group](./3_troubleshooting.md#telegram-troubleshooting-support-group) and we will check as soon as possible.
 
   Other channels for suggestions/requests include [XDC Forum](https://forum.xinfin.org/) and [GitHub Issues](https://github.com/XinFinOrg/XDC-Subnet/issues)
 

docs/deployment/6_subnet_deployment_generator_changelog.md

@@ -1,10 +1,13 @@
 ---
 sidebar_label: "Subnet Deployment Generator Changelog"
-sidebar_position: 6
+sidebar_position: 5
 ---
 
 # Subnet Deployment Generator Changelog
 
+### v0.1.0 - 2024/09/28
+  - WIP
+
 ### v0.3.2 - 2024/08/15
   - Changed frontend default due to clashing from 5000 to 5555
 

docs/usage/2_faucet.md

@@ -0,0 +1,58 @@
+---
+sidebar_label: "Faucet"
+sidebar_position: 2
+---
+# Faucet
+
+In Subnets, all native tokens are initially assigned to the Grandmaster Wallet. To allow users to use the Subnet, we have to distribute the tokens out of the Grandmaster. We have provided convenient scripts for you to easily share Subnet tokens to your users.
+
+## One-time Transfer
+
+Under `generated` directory run the Faucet script. 
+
+```
+./scripts/faucet.sh
+```
+
+The script will ask for your source wallet private key. You can use the Grandmaster Wallet(check `keys.json` file for the private key). 
+Then input the destination wallet and the transfer amount.
+
+![Example](./img/faucet.png)
+
+## Faucet Server
+
+Under `generated` directory run the Faucet server script.
+
+```
+./scripts/faucet-server.sh
+```
+
+The script will ask for your source wallet private key. you can use the Grandmaster Wallet(check `keys.json` for the private key).
+By default, the server is hosted on port `5211` of your machine. Then, on your browser, visit the url: `http://127.0.0.1:5211`
+
+![Example](./img/faucet-server1.png)
+
+Input your destination wallet or feel free to generate a random wallet via Address Generator.
+
+![Example](./img/faucet-server2.png)
+
+Submit and wait for confirmation.
+
+![Example](./img/faucet-server3.png)
+
+You can host this on any server and allow users to make token requests by themselves.
+
+## Transfer Subnet Funds Without Faucet
+
+The Faucet is not neccessary needed for funds transfer, most Ethereum compatible web3 wallet will also work. 
+
+First import a new wallet with the Grandmaster private key. Then add a custom network pointing to your Subnet RPC URL. Finally, use the web3 wallet for tokens transfer.
+
+
+## Faucet Source Code
+
+Please feel free to check the below repositories for the Subnet Faucet source code.
+
+https://github.com/XinFinOrg/XinFin-Node/tree/master/subnet/deployment-generator/scripts
+
+https://github.com/XinFinOrg/XinFin-Node/tree/master/subnet/deployment-generator/src/faucet.js

docs/deployment/4_blockchain_explorer.md → docs/usage/3_explorer.md

@@ -1,6 +1,6 @@
 ---
-sidebar_label: "4. Blockchain Explorer"
-sidebar_position: 4
+sidebar_label: "Blockchain Explorer"
+sidebar_position: 3
 ---
 
 # Blockchain Explorer

docs/usage/_category_.json

@@ -1,8 +1,11 @@
 {
-  "label": "UI Usage Guide",
-  "position": 4,
+  "label": "Using the Subnet",
+  "position": 5,
   "link": {
     "type": "generated-index",
-    "description": "The guide for XDC Subnet user interface"
+    "description": "The guide to using XDC-Subnet"
   }
-}
+}
+
+
+

docs/usage/ui/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "UI Usage Guide",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "The guide for XDC Subnet user interface"
+  }
+}