Skip to content

Commit

Permalink
Merge pull request #326 from 0xPolygonMiden/dominik_docs_iterate_over…
Browse files Browse the repository at this point in the history
…view

Docs: iterate over overview section
  • Loading branch information
Dominik1999 authored Nov 30, 2023
2 parents 1261a5d + 0fe9c20 commit c57448a
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 13 deletions.
2 changes: 0 additions & 2 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,5 @@
- [Verifier Contract](network/verifier-contract.md)
- [Bridge](network/bridge.md)
- [Roadmap](./roadmap.md)
- [Developer info](./developer-info.md)
- [Specifications](./specifications.md)
- [Cryptographic primitives](./crypto-primitives.md)
- [Tiered Sparse Merkle Tree (TSMT)](crypto-primitives/tsmt.md)
1 change: 0 additions & 1 deletion docs/src/developer-info.md

This file was deleted.

20 changes: 11 additions & 9 deletions docs/src/introduction/overview.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# Overview
Polygon Miden, a ZK-optimized rollup with client-side proving, will complement Polygon’s set of zero-knowledge solutions aiming to become the internet's value layer.
This documentation presents detailed guides on:

Unlike many other rollups, Polygon Miden prioritizes ZK-friendliness over EVM compatibility. It also uses a novel state model to exploit the full power of a ZK-centric design. These design decisions allow developers to create applications that are currently difficult or impractical to build on account-based systems.
* [Getting started](getting-started.md)
* [Architecture](../architecture.md)
* [Network design](../network.md)
* [Roadmap](../roadmap.md)
* [Cryptographic primitives](../crypto-primitives.md)

This documentation presents detailed guides on:
**Getting started** provides an hands-om guide on how builders can use our **testnet**.

* Polygon Miden Architecture
* Polygon Miden Network Design [WIP]
* Participating in the Polygon Miden Testnet [WIP]
**Architecture** describes Miden's unique state and execution model - an actor-based model with concurrent off-chain state.

The Polygon Miden **Architecture** describes Miden's unique state and execution model - an actor-based model with concurrent off-chain state.
**Network design** describes how the architecture is implemented into a zero-knowledge rollup. It describes the software components, RPC interfaces of the Miden Nodes and Cliets.

From the **Network Design** perspective, Polygon Miden uses a bi-directional token bridge and verifier contract to ensure computational integrity [WIP]. Miden Nodes act as operators that keep the state and compress state transitions recursively into STARK-proofs. The token bridge on Ethereum verifies these proofs. Users can run Miden Clients to send RPC requests to the Miden Nodes to update the state.
**Roadmap** shows the timeline for user facing features that users can expect.

Once we are ready, we will provide an in-depth guide on how developers can participate to use our **testnet**.
**Cryptographic primitives** provides an in-depth description of the primitives used in the Miden rollup and the Miden VM.
1 change: 0 additions & 1 deletion docs/src/specifications.md

This file was deleted.

0 comments on commit c57448a

Please sign in to comment.