Merge pull request #2 from zypher-game/feat-add-zytron

add zytron doc

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "themes/adidoks"]
 	path = themes/adidoks
-	url = https://github.com/aaranxu/adidoks.git
+	url = https://github.com/sunhuachuang/adidoks.git

config.toml

@@ -97,19 +97,6 @@ section = "blog" # see config.extra.main~url
 ## Sitelinks Search Box
 site_links_search_box = false
 
-# Menu items
-[[extra.menu.main]]
-name = "Docs"
-section = "docs"
-url = "/docs/guide/overview/"
-weight = 10
-
-[[extra.menu.main]]
-name = "Blog"
-section = "blog"
-url = "/blog/"
-weight = 20
-
 [[extra.menu.social]]
 name = "Twitter"
 pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="currentColor" class="bi bi-twitter" viewBox="0 0 16 16"><path d="M5.026 15c6.038 0 9.341-5.003 9.341-9.334 0-.14 0-.282-.006-.422A6.685 6.685 0 0 0 16 3.542a6.658 6.658 0 0 1-1.889.518 3.301 3.301 0 0 0 1.447-1.817 6.533 6.533 0 0 1-2.087.793A3.286 3.286 0 0 0 7.875 6.03a9.325 9.325 0 0 1-6.767-3.429 3.289 3.289 0 0 0 1.018 4.382A3.323 3.323 0 0 1 .64 6.575v.045a3.288 3.288 0 0 0 2.632 3.218 3.203 3.203 0 0 1-.865.115 3.23 3.23 0 0 1-.614-.057 3.283 3.283 0 0 0 3.067 2.277A6.588 6.588 0 0 1 .78 13.58a6.32 6.32 0 0 1-.78-.045A9.344 9.344 0 0 0 5.026 15z"/></svg>'
@@ -140,5 +127,5 @@ weight = 10
 
 [[extra.footer.nav]]
 name = "Code of Conduct"
-url = "/docs/contributing/code-of-conduct/"
+url = "/zk/contributing/code-of-conduct/"
 weight = 20

content/_index.md

@@ -5,25 +5,31 @@ title = "Zypher Documentation"
 # The homepage contents
 [extra]
 lead = 'Game infrastructure for Autonomous Open World, Featuring ZK + AI'
-url = "/docs/guide/overview/"
+url = "/zk/guide/overview/"
 url_button = "Get started"
 repo_version = "v0.1.0"
 repo_license = "Open-source GPLv3 License."
 repo_url = "https://github.com/zypher-game"
 
 # Menu items
-[[extra.menu.main]]
-name = "Docs"
-section = "docs"
-url = "/docs/guide/overview/"
-weight = 10
-
 [[extra.menu.main]]
 name = "Blog"
 section = "blog"
 url = "/blog/"
+weight = 10
+
+[[extra.menu.main]]
+name = "ZK"
+section = "zk"
+url = "/zk/guide/overview/"
 weight = 20
 
+[[extra.menu.main]]
+name = "Zytron"
+section = "zytron"
+url = "/zytron/chain/overview/"
+weight = 30
+
 [[extra.list]]
 title = "Secret Engine"
 content = 'A suite of SDKs to enable secure execution of verifiable encrypted computations, ensuring strategic elements remain sealed on-chain'

content/zk/_index.md

@@ -0,0 +1,9 @@
++++
+title = "ZK"
+description = "The zk engine documents"
+date = 2024-05-01T08:00:00+00:00
+updated = 2024-05-01T08:00:00+00:00
+sort_by = "weight"
+weight = 1
+template = "docs/section.html"
++++

content/docs/contributing/code-of-conduct.md → content/zk/contributing/code-of-conduct.md

@@ -9,6 +9,7 @@ sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = "Contributor Covenant Code of Conduct."
 toc = true
 top = false

content/docs/contributing/how-to-contribute.md → content/zk/contributing/how-to-contribute.md

@@ -9,6 +9,7 @@ sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = "Contribute to ZypherGame, improve documentation, or submit to showcase."
 toc = true
 top = false

content/docs/guide/guessing-game.md → content/zk/guide/guessing-game.md

@@ -4,11 +4,12 @@ description = "Learning the zk-powered game by programming a guessing game."
 date = 2021-05-01T08:20:00+00:00
 updated = 2021-05-01T08:20:00+00:00
 draft = false
-weight = 12
+weight = 1001
 sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = "Learning the zk-powered game by programming a guessing game."
 toc = true
 top = false

content/docs/guide/overview.md → content/zk/guide/overview.md

@@ -4,11 +4,13 @@ description = "A Next-Gen Web3 Infrastructure for Autonomous Worlds & Zero Knowl
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 10
+weight = 1000
 sort_by = "weight"
+section = "zk"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = 'A Next-Gen Web3 Infrastructure for Autonomous Worlds & Zero Knowledge Game Engines'
 toc = true
 top = false
@@ -23,8 +25,5 @@ Detailed introduction to zero-knowledge proofs and secret engine. [Quick Start 
 ## Z4
 Detailed introduction to multiple online real-time game. [Quick Start →](../../z4/overview)
 
-## Zytron
-Detailed introduction to L3 game chain. [Quick Start →](../../zytron/overview)
-
 ## Contributing
 Find out how to contribute to Doks. [Contributing →](../../contributing/how-to-contribute)

content/docs/uzkge/matchmaking.md → content/zk/uzkge/matchmaking.md

@@ -4,11 +4,12 @@ description = "A zk-powered matchmaking"
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 26
+weight = 2002
 sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = 'A zk-powered matchmaking'
 toc = true
 top = false

content/docs/uzkge/overview.md → content/zk/uzkge/overview.md

@@ -4,11 +4,12 @@ description = "A zero Knowledge Game Engine."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 21
+weight = 2000
 sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = 'A zero Knowledge Game Engine'
 toc = true
 top = false

content/docs/uzkge/shuffle.md → content/zk/uzkge/shuffle.md

@@ -4,11 +4,12 @@ description = "A zk-powered shuffle for cards"
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 25
+weight = 2001
 sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = 'A zk-powered shuffle for cards'
 toc = true
 top = false

content/docs/z4/based-risc0.md → content/zk/z4/based-risc0.md

@@ -4,11 +4,12 @@ description = "Universal Z4 node based on RISC0-zkVM"
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 33
+weight = 3002
 sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = 'Universal Z4 node based on RISC0-zkVM'
 toc = true
 top = false

content/docs/z4/based-uzkge.md → content/zk/z4/based-uzkge.md

@@ -4,11 +4,12 @@ description = "A customized zk & room for game."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 32
+weight = 3001
 sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = 'A customized zk & room for game'
 toc = true
 top = false

content/docs/z4/overview.md → content/zk/z4/overview.md

@@ -4,11 +4,12 @@ description = "A multiple online real-time game engine."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 31
+weight = 3000
 sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
+section = "zk"
 lead = 'A multiple online real-time game engine'
 toc = true
 top = false

content/zytron/_index.md

@@ -0,0 +1,9 @@
++++
+title = "Zytron"
+description = "A layer3 game chain framework"
+date = 2024-05-01T08:00:00+00:00
+updated = 2024-05-01T08:00:00+00:00
+sort_by = "weight"
+weight = 1
+template = "docs/section.html"
++++

content/zytron/chain/0gas.md

@@ -0,0 +1,58 @@
++++
+title = "0 GAS"
+description = "Zytron chain is 0 gas"
+date = 2024-05-01T08:00:00+00:00
+updated = 2024-05-01T08:00:00+00:00
+draft = false
+weight = 4001
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+section = "zytron"
+lead = 'Zytron chain is 0 gas'
+toc = true
+top = false
++++
+
+## 0 Gas
+
+If your address and the DApp you use support Zytron's 0gas service,
+you only need to use Metamask to initiate a signature to authorize the transaction.
+
+> Pic here.
+
+## 0gas SBT
+
+Different Zytron networks have a contract that records whether users can be
+exempted from gas permissions. This permission is displayed in SBT form.
+Users can check whether there is SBT in their wallet to check whether 0gas interaction is possible.
+
+### Zytron on Linea SBT
+
+|  Field   | Value  |
+|  ----  | ----  |
+| Network Name  | [Linea(Sepolia)](https://chainlist.org/chain/59141) |
+| Contract Address | 0x |
+
+### Zytron on B2 SBT
+
+|  Field   | Value  |
+|  ----  | ----  |
+| Network Name  | B2 |
+| Contract Address | 0x |
+
+## Set Priority Gas in Metamask
+
+Since zytron allows lower transaction gas support, metamask cannot be directly adapted in many cases.
+Therefore, you need to manually configure the Priority Gas Price.
+
+To enable this function, please follow these step:
+
+1. In the send transaction interface, click Estimated fee edit button (blue button).
+2. Click Advanced.
+3. You can adjust the Priority Gas Price according to your needs. The larger this value, 
+    the easier it is for the transaction to be confirmed by the network.
+    We recommend using 0.002 as the Priority Gas Price.
+4. To avoid doing this for every future transaction, please click "Save these values as my default for the..."
+5. Click "Save" and comfirm transaction.

content/docs/zytron/_index.md → content/zytron/chain/_index.md

@@ -1,6 +1,6 @@
 +++
-title = "zytron"
-description = "Quick start and complete a L3 game chain with zytron."
+title = "Zytron Chain"
+description = "A L3 game chain"
 date = 2025-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 template = "docs/section.html"

content/zytron/chain/bridge.md

@@ -0,0 +1,19 @@
++++
+title = "Bridge"
+description = "Bridge Token to Zytron Chain"
+date = 2024-05-01T08:00:00+00:00
+updated = 2024-05-01T08:00:00+00:00
+draft = false
+weight = 4002
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+section = "zytron"
+lead = 'Bridge Token to Zytron Chain'
+toc = true
+top = false
++++
+
+## Bridge Token to Zytron Chain
+COMMING SOON

content/zytron/chain/overview.md

@@ -0,0 +1,55 @@
++++
+title = "What's Zytron Chain"
+description = "A L3 game chain."
+date = 2024-05-01T08:00:00+00:00
+updated = 2024-05-01T08:00:00+00:00
+draft = false
+weight = 4000
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+section = "zytron"
+lead = 'A L3 game chain'
+toc = true
+top = false
++++
+
+## Add Zytron Testnet
+
+Zytron has three test networks. You can choose to use it according to your needs.
+
+### Zytron on Linea
+
+|  Field   | Value  |
+|  ----  | ----  |
+| Network Name  | Zytron Linea(Sepolia) Testnet |
+| RPC | http://linea-testnet-zytron.zypher.game:8545/ |
+| ChainId | 50098 |
+| Explorer | http://linea-testnet-zytron-blockscout.zypher.game/ |
+| Currency | ETH |
+| Bridge |  |
+
+### Zytron on B2
+
+|  Field   | Value  |
+|  ----  | ----  |
+| Network Name  | Zytron B2 Testnet |
+| RPC | http://b2-testnet-zytron.zypher.game:8545/ |
+| ChainId | 50097 |
+| Explorer | http://b2-testnet-zytron-blockscout.zypher.game/ |
+| Currency | BTC |
+| Bridge |  |
+
+### Zytron on Celestia
+
+|  Field   | Value  |
+|  ----  | ----  |
+| Network Name  | Zytron Celestia Testnet |
+| RPC | http://zytron-testnet.zypher.game:8545/ |
+| ChainId | 80085 |
+| Explorer | http://blockscout-rollkit-zytron-testnet.zypher.game/ |
+| Currency | ETH |
+| Bridge <sup>1</sup> | -- |
+
+> <sup>1</sup>Zytron on Celestia has no bridge.