Update documents

config.toml

@@ -110,12 +110,6 @@ url = "https://github.com/zypher-game"
 post = "v0.1.0"
 weight = 20
 
-[[extra.menu.social]]
-name = "Discord"
-pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="currentColor" class="bi bi-discord" viewBox="0 0 16 16"><path d="M13.545 2.907a13.227 13.227 0 0 0-3.257-1.011.05.05 0 0 0-.052.025c-.141.25-.297.577-.406.833a12.19 12.19 0 0 0-3.658 0 8.258 8.258 0 0 0-.412-.833.051.051 0 0 0-.052-.025c-1.125.194-2.22.534-3.257 1.011a.041.041 0 0 0-.021.018C.356 6.024-.213 9.047.066 12.032c.001.014.01.028.021.037a13.276 13.276 0 0 0 3.995 2.02.05.05 0 0 0 .056-.019c.308-.42.582-.863.818-1.329a.05.05 0 0 0-.01-.059.051.051 0 0 0-.018-.011 8.875 8.875 0 0 1-1.248-.595.05.05 0 0 1-.02-.066.051.051 0 0 1 .015-.019c.084-.063.168-.129.248-.195a.05.05 0 0 1 .051-.007c2.619 1.196 5.454 1.196 8.041 0a.052.052 0 0 1 .053.007c.08.066.164.132.248.195a.051.051 0 0 1-.004.085 8.254 8.254 0 0 1-1.249.594.05.05 0 0 0-.03.03.052.052 0 0 0 .003.041c.24.465.515.909.817 1.329a.05.05 0 0 0 .056.019 13.235 13.235 0 0 0 4.001-2.02.049.049 0 0 0 .021-.037c.334-3.451-.559-6.449-2.366-9.106a.034.034 0 0 0-.02-.019Zm-8.198 7.307c-.789 0-1.438-.724-1.438-1.612 0-.889.637-1.613 1.438-1.613.807 0 1.45.73 1.438 1.613 0 .888-.637 1.612-1.438 1.612Zm5.316 0c-.788 0-1.438-.724-1.438-1.612 0-.889.637-1.613 1.438-1.613.807 0 1.451.73 1.438 1.613 0 .888-.631 1.612-1.438 1.612Z"/></svg>'
-url = "https://discord.com/invite/MKJZhS4p2T"
-weight = 30
-
 # Footer contents
 [extra.footer]
 info = 'Powered by <a href="https://github.com/zypher-game/docs">Zypher Docs</a>'

content/_index.md

@@ -16,45 +16,51 @@ repo_url = "https://github.com/zypher-game"
 name = "Blog"
 section = "blog"
 url = "/blog/"
-weight = 10
+weight = 1
 
 [[extra.menu.main]]
 name = "ZK"
 section = "zk"
 url = "/zk/guide/overview/"
-weight = 20
+weight = 10
 
 [[extra.menu.main]]
-name = "Zytron"
-section = "zytron"
-url = "/zytron/chain/overview/"
-weight = 30
+name = "Z4"
+section = "z4"
+url = "/z4/overview/"
+weight = 20
 
 [[extra.menu.main]]
 name = "PoZK"
 section = "pozk"
 url = "/pozk/overview/"
+weight = 30
+
+[[extra.menu.main]]
+name = "Zytron"
+section = "zytron"
+url = "/zytron/chain/overview/"
 weight = 40
 
 [[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'
+title = "ZK SDK"
+content = 'A suite of zk-Legos-as-SDKs. Plug and play, easy and free customization.'
 
 [[extra.list]]
-title = "AW SDK"
-content = 'A suite of zk-Legos-as-SDKs to enable games to hyper-scale vertically. Plug and play, easy and free customization'
+title = "Z4 Framework"
+content = 'A multiple online real-time game server framework. Low latency, high performance, ZK protection.'
 
 [[extra.list]]
-title = "Z4 Framework"
-content = 'A multiple online real-time game server framework. Low latency, high performance, ZK protection'
+title = "PoZK"
+content = "The ZK & Z4 mining network. Turning RUNTIME into decentralization."
 
 [[extra.list]]
-title = "Zytron"
-content = "A Highly customizable Layer 3 sovereign roll up stack. The most viable infrastructure for production-level MMOs"
+title = "zkVM"
+content = 'Integrate multiple zkVMs, make game development simple and efficient. Bring ZK into the game world.'
 
 [[extra.list]]
-title = "Generative AI"
-content = "The blessing of AI for games allows all gamer to enjoy the fun of freely customizing games"
+title = "Zytron"
+content = "A Highly customizable Layer 3 sovereign roll up stack. Gasless and high speed."
 
 [[extra.list]]
 title = "Games DAO"

content/pozk/_index.md

@@ -3,6 +3,5 @@ title = "PoZK"
 description = "Prover network for ZK games."
 template = "docs/section.html"
 sort_by = "weight"
-weight = 1
-draft = false
+weight = 3000
 +++

content/pozk/miner/_index.md

@@ -0,0 +1,8 @@
++++
+title = "Miner"
+description = "How to become a miner"
+template = "docs/section.html"
+sort_by = "weight"
+weight = 3200
+draft = false
++++

content/pozk/miner.md → content/pozk/miner/miner.md

@@ -4,9 +4,8 @@ description = "How to become a miner and earn rewards."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 5002
+weight = 3201
 sort_by = "weight"
-section = "pozk"
 template = "docs/page.html"
 
 [extra]

content/pozk/overview.md

@@ -4,7 +4,7 @@ description = "Prover network for ZK games."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 5000
+weight = 3001
 sort_by = "weight"
 section = "pozk"
 template = "docs/page.html"

content/pozk/player/_index.md

@@ -0,0 +1,8 @@
++++
+title = "Player"
+description = "How to play for earn"
+template = "docs/section.html"
+sort_by = "weight"
+weight = 3300
+draft = false
++++

content/pozk/player.md → content/pozk/player/player.md

@@ -4,9 +4,8 @@ description = "How to play games and earn rewards."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 5003
+weight = 3301
 sort_by = "weight"
-section = "pozk"
 template = "docs/page.html"
 
 [extra]

content/pozk/2048.md → content/pozk/prover/2048.md

@@ -4,9 +4,8 @@ description = "An example about how to build prover and play."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 5005
+weight = 3111
 sort_by = "weight"
-section = "pozk"
 template = "docs/page.html"
 
 [extra]

content/pozk/prover/_index.md

@@ -0,0 +1,8 @@
++++
+title = "Prover"
+description = "How to build a prover"
+template = "docs/section.html"
+sort_by = "weight"
+weight = 3100
+draft = false
++++

content/pozk/prover.md → content/pozk/prover/prover.md

@@ -1,17 +1,16 @@
 +++
-title = "Build a prover (Game)"
-description = "How to build a prover for game and use PoZK network."
+title = "Build a ZK game"
+description = "How to build a ZK prover for game and use PoZK network."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 5001
+weight = 3101
 sort_by = "weight"
-section = "pozk"
 template = "docs/page.html"
 
 [extra]
 section = "pozk"
-lead = 'How to build a prover for game and use PoZK network.'
+lead = 'How to build a ZK prover for game and use PoZK network.'
 toc = true
 top = false
 +++

content/pozk/prover/z4.md

@@ -0,0 +1,19 @@
++++
+title = "Build a Z4 runner"
+description = "How to build a Z4 runner for game and use PoZK network."
+date = 2021-05-01T08:00:00+00:00
+updated = 2021-05-01T08:00:00+00:00
+draft = false
+weight = 3102
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+section = "pozk"
+lead = 'How to build a Z4 runner for game and use PoZK network.'
+toc = true
+top = false
++++
+
+## Introduction
+Once you have [built a z4 node based on pozk](/z4/node/pozk/), the next step is how to register the z4 node to the pozk network and stake it.

content/pozk/reward/_index.md

@@ -0,0 +1,8 @@
++++
+title = "Reward"
+description = "How to collect rewards"
+template = "docs/section.html"
+sort_by = "weight"
+weight = 3400
+draft = false
++++

content/pozk/reward.md → content/pozk/reward/reward.md

@@ -4,9 +4,8 @@ description = "Reward and punishment mechanism."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 5004
+weight = 3401
 sort_by = "weight"
-section = "pozk"
 template = "docs/page.html"
 
 [extra]

content/z4/_index.md

@@ -0,0 +1,7 @@
++++
+title = "Z4"
+description = "A multiple online real-time game framework."
+template = "docs/section.html"
+sort_by = "weight"
+weight = 2000
++++

content/z4/node/_index.md

@@ -0,0 +1,8 @@
++++
+title = "Z4 Node"
+description = "How to build a Z4 node"
+template = "docs/section.html"
+sort_by = "weight"
+weight = 2100
+draft = false
++++

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

@@ -1,15 +1,15 @@
 +++
 title = "Customized Node"
 description = "A customized zk & room for game."
-date = 2021-05-01T08:00:00+00:00
-updated = 2021-05-01T08:00:00+00:00
+date = 2024-05-01T08:00:00+00:00
+updated = 2024-05-01T08:00:00+00:00
 draft = false
-weight = 5001
+weight = 2101
 sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
-section = "zk"
+section = "z4"
 lead = 'A customized zk & room for game'
 toc = true
 top = false

content/z4/node/client.md

@@ -0,0 +1,19 @@
++++
+title = "API & SDK"
+description = "How to interact with Z4 in client"
+date = 2024-11-26T08:00:00+00:00
+updated = 2024-11-26T08:00:00+00:00
+draft = false
+weight = 2103
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+section = "z4"
+lead = 'How to interact with Z4 nodes on the client side'
+toc = true
+top = false
++++
+
+## Contents
+WIP

content/z4/node/pozk.md

@@ -0,0 +1,25 @@
++++
+title = "Based on PoZK"
+description = "A customized zk game running on PoZK"
+date = 2024-11-26T08:00:00+00:00
+updated = 2024-11-26T08:00:00+00:00
+draft = false
+weight = 2102
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+section = "z4"
+lead = 'A customized zk game running on PoZK'
+toc = true
+top = false
++++
+
+## Introduction
+Whether it is based on PoZK engine or custom engine, you can reuse the code of `Handler`. You only need to specify the engine type to be used when starting.
+
+Once you have written a program based on PoZK, the next step is [How to register it in the PoZK network](/pozk/prover/z4/).
+
+## Trait for PoZK
+
+## Running with PoZK

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

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

content/z4/zkvm/_index.md

@@ -0,0 +1,8 @@
++++
+title = "Z4 with zkVM"
+description = "Integrate multiple zkVMs to Z4 framework"
+template = "docs/section.html"
+sort_by = "weight"
+weight = 2200
+draft = false
++++

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

@@ -4,12 +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 = 5002
+weight = 2201
 sort_by = "weight"
 template = "docs/page.html"
 
 [extra]
-section = "zk"
+section = "z4"
 lead = 'Universal Z4 node based on RISC0-zkVM'
 toc = true
 top = false

content/zk/_index.md

@@ -1,7 +1,7 @@
 +++
 title = "ZK"
 description = "The zk engine documents"
-sort_by = "weight"
-weight = 1
 template = "docs/section.html"
+sort_by = "weight"
+weight = 1000
 +++

content/zk/aw/_index.md

@@ -3,6 +3,6 @@ title = "AW engine"
 description = "Various games SDKs and plug-and-play circuits"
 template = "docs/section.html"
 sort_by = "weight"
-weight = 3
+weight = 1200
 draft = false
 +++

content/zk/aw/match3.md

@@ -4,7 +4,7 @@ description = "Match 3 circuit SDK."
 date = 2024-05-01T08:00:00+00:00
 updated = 2024-05-01T08:00:00+00:00
 draft = false
-weight = 3002
+weight = 1203
 sort_by = "weight"
 template = "docs/page.html"
 

content/zk/aw/overview.md

@@ -4,7 +4,7 @@ description = "ZK aggregate world engine."
 date = 2021-05-01T08:00:00+00:00
 updated = 2021-05-01T08:00:00+00:00
 draft = false
-weight = 3000
+weight = 1201
 sort_by = "weight"
 template = "docs/page.html"
 

content/zk/aw/tile_match_2048.md

@@ -4,7 +4,7 @@ description = "2048 circuit SDK."
 date = 2024-05-01T08:00:00+00:00
 updated = 2024-05-01T08:00:00+00:00
 draft = false
-weight = 3001
+weight = 1202
 sort_by = "weight"
 template = "docs/page.html"
 

content/zk/contributing/_index.md

@@ -3,6 +3,6 @@ title = "Contributing"
 description = "Find out how to contribute to Zypher."
 template = "docs/section.html"
 sort_by = "weight"
-weight = 10
+weight = 1997
 draft = false
 +++