Skip to content

Commit 8c8eb20

Browse files
Merge pull request 0xPolygon#540 from 0xPolygon/zkevm/suggest-reorg
zkEVM: Suggested reorg of zkEVM low-level arch docs for clarity and narrative flow
2 parents 00074ea + 4f69929 commit 8c8eb20

File tree

3 files changed

+45
-44
lines changed

3 files changed

+45
-44
lines changed
File renamed without changes.
File renamed without changes.

mkdocs.yml

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ nav:
6969
- zkEVM:
7070
- zkEVM: zkEVM/index.md
7171
- Overview: zkEVM/overview.md
72+
- Releases:
73+
- Etrog upgrade: zkEVM/architecture/protocol/etrog-upgrade.md
7274
- Build:
7375
- Get started: zkEVM/get-started/index.md
7476
- Quick start: zkEVM/get-started/quick-start.md
@@ -156,31 +158,29 @@ nav:
156158
#- Bridge service: zkEVM/architecture/high-level/bridge-service.md
157159
- Architecture low-level:
158160
- Architecture: zkEVM/architecture/index.md
159-
- Upgrades:
160-
- Etrog upgrade: zkEVM/architecture/protocol/etrog-upgrade.md
161-
- Effective gas price:
162-
- Effective gas price: zkEVM/architecture/effective-gas/index.md
163-
- Effective gas price strategy: zkEVM/architecture/effective-gas/zkevm-egp-strat.md
164-
- User transaction flow:
165-
- User transaction flow: zkEVM/architecture/effective-gas/user-tx-flow/index.md
166-
- RPC transaction flow: zkEVM/architecture/effective-gas/user-tx-flow/rpc-flow-egp.md
167-
- Sequencer transaction flow: zkEVM/architecture/effective-gas/user-tx-flow/sequencer-flow-egp.md
168-
- Implementing EGP strategy: zkEVM/architecture/effective-gas/implement-egp-strat.md
169-
- Transaction prioritization: zkEVM/architecture/effective-gas/tx-prioritization-egp.md
170161
- zkEVM protocol:
171162
- zkEVM protocol: zkEVM/architecture/protocol/index.md
172-
- State management: zkEVM/architecture/protocol/state-management.md
173-
- Transaction life cycle:
174-
- Submit transactions: zkEVM/architecture/protocol/transaction-life-cycle/submit-transaction.md
175-
- Transaction execution: zkEVM/architecture/protocol/transaction-life-cycle/transaction-execution.md
176-
- Transaction batching: zkEVM/architecture/protocol/transaction-life-cycle/transaction-batching.md
177-
- Batch sequencing: zkEVM/architecture/protocol/transaction-life-cycle/batch-sequencing.md
178-
- Batch aggregation: zkEVM/architecture/protocol/transaction-life-cycle/batch-aggregation.md
179-
- Sequencing batches: zkEVM/architecture/protocol/sequencing-batches.md
180-
- Incentive mechanism: zkEVM/architecture/protocol/incentive-mechanism.md
181-
- Protocol upgradability: zkEVM/architecture/protocol/upgradability.md
163+
- zkNode: zkEVM/architecture/zknode/index.md
164+
- State management:
165+
- State management: zkEVM/architecture/protocol/state-management.md
166+
- Transaction life cycle:
167+
- Submit transactions: zkEVM/architecture/protocol/transaction-life-cycle/submit-transaction.md
168+
- Transaction execution: zkEVM/architecture/protocol/transaction-life-cycle/transaction-execution.md
169+
- Transaction batching: zkEVM/architecture/protocol/transaction-life-cycle/transaction-batching.md
170+
- Batch sequencing: zkEVM/architecture/protocol/transaction-life-cycle/batch-sequencing.md
171+
- Batch aggregation: zkEVM/architecture/protocol/transaction-life-cycle/batch-aggregation.md
172+
- Sequencing batches: zkEVM/architecture/protocol/sequencing-batches.md
173+
- Data streamer:
174+
- Overall design: zkEVM/architecture/data-streamer/data-streamer-design.md
175+
- Data streamer protocols: zkEVM/architecture/data-streamer/data-streamer-protocols.md
176+
- Bookmarks: zkEVM/architecture/data-streamer/bookmarks.md
177+
- Protocol messages: zkEVM/architecture/data-streamer/client-server-messages.md
178+
- Stream file: zkEVM/architecture/data-streamer/stream-file.md
179+
- How rollbacks work: zkEVM/architecture/data-streamer/how-rollbacks-work.md
182180
- Admin role and governance: zkEVM/architecture/protocol/admin-role.md
183-
- Upgrade process: zkEVM/architecture/protocol/upgrade-process.md
181+
- Upgrades:
182+
- Protocol upgradability: zkEVM/architecture/protocol/upgradability.md
183+
- Upgrade process: zkEVM/architecture/protocol/upgrade-process.md
184184
- Security council: zkEVM/architecture/protocol/security-council.md
185185
- Malfunction resistance:
186186
- Force batches: zkEVM/architecture/protocol/malfunction-resistance/sequencer-resistance.md
@@ -193,30 +193,20 @@ nav:
193193
- Updating rollups: zkEVM/architecture/protocol/unified-LxLy/ulxly-updating-rollups.md
194194
- Global exit trees: zkEVM/architecture/protocol/unified-LxLy/ulxly-exit-trees-node.md
195195
- Cross-chain exchanges: zkEVM/architecture/protocol/unified-LxLy/ulxly-interchain-exchanges.md
196-
- zkNode: zkEVM/architecture/zknode/index.md
197-
- Data streamer:
198-
- Overall design: zkEVM/architecture/data-streamer/data-streamer-design.md
199-
- Data streamer protocols: zkEVM/architecture/data-streamer/data-streamer-protocols.md
200-
- Bookmarks: zkEVM/architecture/data-streamer/bookmarks.md
201-
- Protocol messages: zkEVM/architecture/data-streamer/client-server-messages.md
202-
- Stream file: zkEVM/architecture/data-streamer/stream-file.md
203-
- How rollbacks work: zkEVM/architecture/data-streamer/how-rollbacks-work.md
204-
- The proving system:
205-
- Introduction: zkEVM/architecture/proving-system/intro-proving-sys.md
206-
- Executor: zkEVM/architecture/proving-system/the-executor-comp.md
207-
- Polynomial identity language: zkEVM/architecture/proving-system/polynom-identity-lang.md
208-
- Execution trace design: zkEVM/architecture/proving-system/execution-trace-design.md
209-
- Selector columns: zkEVM/architecture/proving-system/exec-selector-columns.md
210-
- zkEVM and execution traces: zkEVM/architecture/proving-system/exec-trace-and-zkevm.md
211-
- Using lookup tables: zkEVM/architecture/proving-system/secondary-sms-lookup-tables.md
212-
- Recapitulation: zkEVM/architecture/proving-system/prover-and-verifier-recap.md
213-
- L2 state tree concept:
214-
- L2 state tree concept: zkEVM/architecture/l2-state-tree/index.md
215-
- Proving system inputs:
216-
- Proving system inputs: zkEVM/architecture/proving-inputs/index.md
217196
- zkProver:
218197
- zkProver: zkEVM/architecture/zkprover/index.md
219-
- Main state machine:
198+
- zkProver design:
199+
- Introduction: zkEVM/architecture/proving-system/intro-proving-sys.md
200+
- Executor: zkEVM/architecture/proving-system/the-executor-comp.md
201+
- Proving system inputs: zkEVM/architecture/proving-system/proving-inputs.md
202+
- Polynomial identity language: zkEVM/architecture/proving-system/polynom-identity-lang.md
203+
- Execution trace design: zkEVM/architecture/proving-system/execution-trace-design.md
204+
- Selector columns: zkEVM/architecture/proving-system/exec-selector-columns.md
205+
- zkEVM and execution traces: zkEVM/architecture/proving-system/exec-trace-and-zkevm.md
206+
- Using lookup tables: zkEVM/architecture/proving-system/secondary-sms-lookup-tables.md
207+
- L2 state tree concept: zkEVM/architecture/proving-system/l2-state-tree.md
208+
- Recapitulation: zkEVM/architecture/proving-system/prover-and-verifier-recap.md
209+
- Main state machine:
220210
- Main state machine: zkEVM/architecture/zkprover/main-state-machine/index.md
221211
- As a processor: zkEVM/architecture/zkprover/main-state-machine/processor.md
222212
- STARK recursion:
@@ -247,6 +237,17 @@ nav:
247237
- Bits2Field state machine: zkEVM/architecture/zkprover/hashing-state-machines/bits2field-sm.md
248238
- Keccak-f state machine: zkEVM/architecture/zkprover/hashing-state-machines/keccakf-sm.md
249239
- Poseidon state machine: zkEVM/architecture/zkprover/hashing-state-machines/poseidon-sm.md
240+
- Tokenomics:
241+
- Incentive mechanism: zkEVM/architecture/protocol/incentive-mechanism.md
242+
- Effective gas price:
243+
- Effective gas price: zkEVM/architecture/effective-gas/index.md
244+
- Effective gas price strategy: zkEVM/architecture/effective-gas/zkevm-egp-strat.md
245+
- User transaction flow:
246+
- User transaction flow: zkEVM/architecture/effective-gas/user-tx-flow/index.md
247+
- RPC transaction flow: zkEVM/architecture/effective-gas/user-tx-flow/rpc-flow-egp.md
248+
- Sequencer transaction flow: zkEVM/architecture/effective-gas/user-tx-flow/sequencer-flow-egp.md
249+
- Implementing EGP strategy: zkEVM/architecture/effective-gas/implement-egp-strat.md
250+
- Transaction prioritization: zkEVM/architecture/effective-gas/tx-prioritization-egp.md
250251
- Specification:
251252
- Specification: zkEVM/spec/index.md
252253
- Polynomial Identity Language:

0 commit comments

Comments
 (0)