Skip to content

Commit 6311be8

Browse files
update miden docs
1 parent 32f4857 commit 6311be8

File tree

5 files changed

+24
-85
lines changed

5 files changed

+24
-85
lines changed

docs/img/miden/network/Architecture_Overview.svg

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/miden/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
</div>
5959
<div class="grid-container">
6060
<div class="grid-item">
61-
<a href="./introduction/introduction">
61+
<a href="./introduction/">
6262
<div class="product-list-item-header">
6363
<div class="feature-card-heading">zkRollup docs</div>
6464
</div>
Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,37 @@
1-
# Polygon Miden
1+
!!! warning
2+
- Polygon Miden is in development.
3+
- The documentation is also work in progress.
24

3-
> *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.*
5+
## Welcome to Polygon Miden
46

5-
## Welcome to the Polygon Miden Documentation
67
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.
78

89
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.
910

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

12-
* the [Discord](https://discord.gg/0xpolygondevs)
13-
* the [Repo](https://github.com/0xPolygonMiden)
14-
* the [Roadmap](../roadmap)
13+
* the [Discord](https://discord.gg/0xpolygondevs).
14+
* the [Repo](https://github.com/0xPolygonMiden).
15+
* the [Roadmap](../roadmap).
1516

1617
## Miden creates a new design space secured by Ethereum
18+
1719
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.
1820

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

2123
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.
2224

2325
## Benefits of Polygon Miden
24-
* Ethereum security
25-
* Developers can build applications infeasible on other systems, e.g.
26-
* **onchain order book exchange** due to parallel tx exectuion and updatable transactions
27-
* **complex, incomplete information games** due to client-side proving and cheap complex computations
28-
* **safe wallets** due to assets being stored in the accounts and account state can be hidden
29-
* Better privacy properties than on Ethereum - first web2 privacy, later even stronger privacy guarantees
30-
* Transactions can be recalled and updated
31-
* Lower fees due to client-side proving
32-
* dApps on Miden are safe to use due to account abstraction and compile-time safe Rust smart contracts
26+
27+
* Ethereum security.
28+
* Developers can build applications infeasible on other systems, for example:
29+
30+
* *On-chain order book exchanges* due to parallel tx exectuion and updatable transactions.
31+
* *Complex, incomplete information games* due to client-side proving and cheap complex computations.
32+
* *Safe wallets* due to assets being stored in the accounts and account state can be hidden.
33+
34+
* Better privacy properties than on Ethereum - first web2 privacy, later even stronger privacy guarantees.
35+
* Transactions can be recalled and updated.
36+
* Lower fees due to client-side proving.
37+
* dApps on Miden are safe to use due to account abstraction and compile-time safe Rust smart contracts.

docs/miden/introduction/protocol.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

mkdocs.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -282,10 +282,9 @@ nav:
282282
- Miden: miden/index.md
283283
- Overview: miden/overview.md
284284
- Miden zkRollup docs:
285-
- Roadmap: miden/roadmap.md
286-
- Introduction:
287-
- Introduction: miden/introduction/introduction.md
288-
- Protocol: miden/introduction/protocol.md
285+
- Introduction:
286+
- Welcome: miden/introduction/index.md
287+
- Roadmap: miden/roadmap.md
289288
- Architecture:
290289
- Accounts: miden/architecture/accounts.md
291290
- Architecture: miden/architecture/architecture.md

0 commit comments

Comments
 (0)