Skip to content

Commit

Permalink
Merge pull request #325 from 0xPolygonMiden/dominik_docs_iterate_intr…
Browse files Browse the repository at this point in the history
…oduction_and_roadmap

Docs: Add the roadmap to the docs and iterate over the intro section
  • Loading branch information
Dominik1999 authored Nov 30, 2023
2 parents ea54458 + f46ba1b commit 1261a5d
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 11 deletions.
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- [Miden Node](network/miden-node.md)
- [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)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 8 additions & 11 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,30 @@
> *This documentation is still Work In Progress. Some topics have been discussed in greater depth, while others require additional clarification. Sections of this documentation might later be reorganized in order to achieve a better flow.*
## Welcome to the Polygon Miden Documentation
Polygon Miden is a zkRollup for high-throughput and private applications. Anyone can create zero-knowledge proofs of their own state changes, and Miden only verifies. It is expected to launch a public testnet in Q4.
Polygon Miden is a zkRollup for high-throughput and private applications. Users can create zero-knowledge proofs of their own state changes, and the Miden network verifies. It is expected to launch a public testnet in Q1 2024.

This documentation explains the Miden architecture and concepts, the network and its components, and the underlying cryptographic primitives.

Press `s` or for full-text search in the docs.
This documentation explains how to develop on Miden. Furthermore, it explains the Miden architecture and concepts, the network and its components, and the underlying cryptographic primitives.

If you want to join the technical discussion, please check out

* the [Discord](https://discord.gg/0xpolygondevs),
* the [Repo](https://github.com/0xPolygonMiden),
* the roadmap goals
* the [Discord](https://discord.gg/0xpolygondevs)
* the [Repo](https://github.com/0xPolygonMiden)
* the [Roadmap](roadmap.md)

## Miden creates a new design space secured by Ethereum
Our goal is to not only scale Ethereum but to extend it. Rollups - secured by Ethereum - can be new design spaces and even experimental. This is the place to innovate. The base layer, however, should stay conservative and only slowly evolve to ensure the required safety and stability.

Like other rollups, we want to scale Ethereum and inherit its security. We want to provide a safe and decentralized environment for composable smart contracts.
Like other rollups, we scale Ethereum and inherit its security. We want to provide a safe and decentralized environment for composable smart contracts.

Unlike most other rollups, Polygon Miden prioritizes ZK-friendliness over EVM compatibility. It also uses a novel, actor-based state model to exploit the full power of a ZK-centric design. These design choices allow Polygon Miden to extend Ethereum’s feature set. These features allow developers to create applications currently infeasible on EVM-like systems.

## Benefits of Polygon Miden

* Ethereum security
* Developers can build applications infeasible on other systems, e.g.
* **onchain order book exchange** due to parallel tx exectuion and updatable transactions
* **complex, incomplete information games** due to client-side proving and cheap complex computations
* **safe wallets** due to assets being stored in the accounts and account state can be (partially) hidden
* **safe wallets** due to assets being stored in the accounts and account state can be hidden
* Better privacy properties than on Ethereum - first web2 privacy, later even stronger privacy guarantees
* Transactions can be recalled and updated
* Lower fees due to client-side proving
* dApps on Miden are safe to use due to account abstraction and modern smart contract languages
* dApps on Miden are safe to use due to account abstraction and compile-time safe Rust smart contracts
3 changes: 3 additions & 0 deletions docs/src/roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<p align="center">
<img src="./diagrams/roadmap/miden_roadmap_dec_23.jpg">
</p>

0 comments on commit 1261a5d

Please sign in to comment.