Skip to content

Commit 74880c3

Browse files
Merge pull request 0xPolygon#218 from 0xPolygon/km/type-1-learn
Move type 1 prover docs to LEARN section
2 parents 968f314 + bd24193 commit 74880c3

File tree

7 files changed

+35
-29
lines changed

7 files changed

+35
-29
lines changed

docs/cdk/architecture/type-1-prover/intro-t1-prover.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
The Polygon Type 1 Prover is a zk-evm proving component used for creating proofs on your ZK-EVM chain. It has been developed in collaboration with the Toposware team.
22

3+
!!! info
4+
The Polygon Type 1 Prover is not yet ready for full implementation into a CDK stack.
5+
36
## Get started
47

58
If you want to get up and running quickly, follow the [how to deploy the Type 1 Prover guide](../../how-to/deploy-t1-prover.md).

docs/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ hide:
9898
<div class="product-list-header"><img width="24px" src="img/home/learn-icon.svg" loading="lazy" alt="">
9999
<h3 class="heading-h3 margin-none">LEARN</h3>
100100
</div>
101-
<p class="feature-paragraph">Deep dives only. Further your understanding of Polygon scaling technology.</p>
101+
<p class="feature-paragraph">Deep dives only. Further your understanding of Polygon scaling technology.</p></br>
102102
</div>
103103
<a href="learn" class="flex-card-item w-inline-block">
104104
<div class="product-list-item-header">
@@ -109,34 +109,34 @@ hide:
109109
</div>
110110
<p class="feature-paragraph"> Resources focused on both current and future Polygon technologies. It features detailed guides, foundational concepts, and previews of upcoming innovations. </p>
111111
</a>
112-
<a href="learn/welcome" class="flex-card-item w-inline-block">
112+
<a href="cdk/architecture/type-1-prover/intro-t1-prover" class="flex-card-item w-inline-block">
113113
<div class="product-list-item-header">
114-
<div class="feature-card-heading">Welcome</div>
114+
<div class="feature-card-heading">Type 1 Prover</div>
115115
<div class="arrow-embed w-embed"><svg xmlns="http://www.w3.org/2000/svg" display="block" width="100%" height="auto" viewbox="0 0 16 17" fill="none">
116116
<path d="M9.98805 5.70133L3.41071 12.2787L4.58922 13.4572L11.1666 6.87976V12.2013H12.8333V4.03467H4.66665V5.70133H9.98805Z" fill="currentColor"></path>
117117
</svg></div>
118118
</div>
119-
<p class="feature-paragraph"> This segment aims to educate users about the intricacies of ZK-powered L2s on Ethereum, offering a blend of theoretical understanding and practical application.</p>
119+
<p class="feature-paragraph">The Polygon Type 1 proving component used for creating proofs on your ZK-EVM chain.</p>
120120
</a>
121-
<a href="learn/deep-dive-arch" class="flex-card-item w-inline-block">
121+
<a href="learn/agglayer" class="flex-card-item w-inline-block">
122122
<div class="product-list-item-header">
123-
<div class="feature-card-heading">Polygon 2.0</div>
123+
<div class="feature-card-heading">Agg Layer</div>
124124
<div class="arrow-embed w-embed"><svg xmlns="http://www.w3.org/2000/svg" display="block" width="100%" height="auto" viewbox="0 0 16 17" fill="none">
125125
<path d="M9.98805 5.70133L3.41071 12.2787L4.58922 13.4572L11.1666 6.87976V12.2013H12.8333V4.03467H4.66665V5.70133H9.98805Z" fill="currentColor"></path>
126126
</svg></div>
127127
</div>
128-
<p class="feature-paragraph">A vision for a unified web of ZK-powered L2s on Ethereum, built using Polygon technology. Unlimited scale, unified liquidity, and blockspace on demand.</p>
128+
<p class="feature-paragraph">Introducing the multi-chain, multi-transaction Polygon Agg Layer; what it is and how it works.</p>
129129
</a>
130-
<a href="learn/liquidity-and-scalability" class="flex-card-item w-inline-block">
130+
<a href="https://polygon.technology/blog/reorgs-demystified-insights-from-monitoring-with-a-sensor-network" class="flex-card-item w-inline-block">
131131
<div class="product-list-item-header">
132-
<div class="feature-card-heading">Unified liquidity</div>
132+
<div class="feature-card-heading">Understanding reorgs</div>
133133
<div class="arrow-embed w-embed"><svg xmlns="http://www.w3.org/2000/svg" display="block" width="100%" height="auto" viewbox="0 0 16 17" fill="none">
134134
<path d="M9.98805 5.70133L3.41071 12.2787L4.58922 13.4572L11.1666 6.87976V12.2013H12.8333V4.03467H4.66665V5.70133H9.98805Z" fill="currentColor"></path>
135135
</svg></div>
136136
</div>
137-
<p class="feature-paragraph">Level up your understanding of zero-knowledge with whitepapers by the researchers at Polygon Labs.</p>
137+
<p class="feature-paragraph">Reorgs demystified: insights from monitoring with a sensor network.</p>
138138
</a>
139-
<a href="learn/polygon-protocols" class="flex-card-item w-inline-block">
139+
<a href="learn/polygon-protocols" class="flex-card-item last-item w-inline-block">
140140
<div class="product-list-item-header">
141141
<div class="feature-card-heading">Polygon protocols</div>
142142
<div class="arrow-embed w-embed"><svg xmlns="http://www.w3.org/2000/svg" display="block" width="100%" height="auto" viewbox="0 0 16 17" fill="none">

docs/pos/get-started/becoming-a-validator.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,12 +178,12 @@ The following step-by-step guides will take you through the process of running a
178178

179179
* [Start and run the nodes with Ansible](/pos/how-to/validator/validator-ansible).
180180
* [Start and run the nodes with binaries](/pos/how-to/validator/validator-binaries).
181-
* [Stake as a validator](/pos/how-to/operate-maintain-node/validator-staking-operations).
181+
* [Stake as a validator](/pos/how-to/operate-validator-node/validator-staking-operations).
182182

183183
### Maintain your validator nodes
184184

185-
* [Change the signer address](/pos/how-to/operate-maintain-node/change-signer-address).
186-
* [Change the commission](/pos/how-to/operate-maintain-node/validator-commission-operations).
185+
* [Change the signer address](/pos/how-to/operate-validator-node/change-signer-address).
186+
* [Change the commission](/pos/how-to/operate-validator-node/validator-commission-operations).
187187

188188
### Community assistance
189189

docs/pos/how-to/troubleshoot/technical-faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ Delete Bor: `sudo rm -rf /var/lib/bor`
382382

383383
### 28. What to do when you get "Wrong Block.Header.AppHash." error
384384

385-
If your node fails with an `appHash` error, you'll need to restore it using a snapshot. See the [guide available here](/pos/node-howto/snapshots).
385+
If your node fails with an `appHash` error, you'll need to restore it using a snapshot. See the [guide available here](../../how-to/snapshots.md).
386386

387387
Please make sure you are either using the chain flag in your service file, or the chain flag is set in your `config/heimdall-config.toml` file.
388388

docs/pos/how-to/validator/validator-ansible.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
This section guides you through starting and running the validator node through an Ansible playbook.
33

4-
For the system requirements, see [Validator Node System Requirements](/validator-node-system-requirements.md).
4+
For the system requirements, see [Validator Node System Requirements](validator-system-requirements.md).
55

66
If you would like to start and run the validator node from binaries, see the guide on [spinning up a Validator node using binaries](./validator-binaries.md).
77

@@ -568,4 +568,4 @@ Now that your Sentry and Validator nodes are synced and running, head over to [D
568568

569569
## Proceed to staking
570570

571-
Now that you have your Sentry and Validator nodes health-checked, proceed to [Staking](/how-to/operating/validator-node/staking.md).
571+
Now that you have your Sentry and Validator nodes health-checked, proceed to [Staking](../../how-to/operate-validator-node/validator-staking-operations.md).

docs/pos/how-to/validator/validator-binaries.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ follow the [Validator Node System Requirements](./validator-system-requirements.
66

77
!!!tip Snapshots
88
Steps in this guide involve waiting for the **Heimdall** and **Bor** services to fully sync.
9-
This process takes several days to complete. Alternatively, you can use a maintained snapshot, which will reduce the sync time to a few hours. For detailed instructions, see [<ins>Snapshot Instructions for Heimdall and Bor</ins>](/pos/how-to/snapshots.md).
9+
This process takes several days to complete. Alternatively, you can use a maintained snapshot, which will reduce the sync time to a few hours. For detailed instructions, see [<ins>Snapshot Instructions for Heimdall and Bor</ins>](../../how-to/snapshots.md).
1010

1111
For snapshot download links, see [<ins>Polygon Chains Snapshots</ins>](https://snapshot.polygon.technology/).
1212

@@ -550,4 +550,4 @@ Now that your sentry and validator nodes are in sync and running, head over to
550550
## Next Steps: Staking
551551

552552
Now that you have your sentry and validator nodes are health-checked, proceed to
553-
the [Staking](/how-to/operating/validator-node/staking.md) guide to start backing the network.
553+
the [Staking](../../how-to/operate-validator-node/validator-staking-operations.md) guide to start backing the network.

mkdocs.yml

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,18 +81,8 @@ nav:
8181
- Start services: cdk/get-started/deploy-rollup/start-services.md
8282
- Connect to CDK testnet: cdk/get-started/connect-testnet.md
8383
- How to:
84-
- Run Type 1 Prover quickly: cdk/how-to/deploy-t1-prover.md
85-
- Deploy Type 1 Prover on devnet: cdk/how-to/deploy-t1-prover-devnet.md
8684
- Manage allowlists with policies: cdk/how-to/manage-policies.md
8785
- Architecture:
88-
- Polygon Type 1 Prover:
89-
- Introduction and definitions: cdk/architecture/type-1-prover/intro-t1-prover.md
90-
- Type 1 design challenges: cdk/architecture/type-1-prover/t1-design-challenge.md
91-
- Architectural overview: cdk/architecture/type-1-prover/t1-architecture.md
92-
- Tests and proving costs: cdk/architecture/type-1-prover/testing-and-proving-costs.md
93-
- CPU component: cdk/architecture/type-1-prover/t1-cpu-component.md
94-
- CTL protocol: cdk/architecture/type-1-prover/t1-ctl-protocol.md
95-
- Range checks: cdk/architecture/type-1-prover/t1-rangechecks.md
9686
- DAC: cdk/architecture/dac.md
9787
- Specification:
9888
- Validium vs rollup: cdk/spec/validium-vs-rollup.md
@@ -575,6 +565,19 @@ nav:
575565
- Learn: learn/index.md
576566
- Welcome: learn/welcome.md
577567
- Polygon AggLayer: learn/agglayer.md
568+
- Polygon Type 1 Prover:
569+
- Introduction and definitions: cdk/architecture/type-1-prover/intro-t1-prover.md
570+
- How to:
571+
- Run Type 1 Prover quickly: cdk/how-to/deploy-t1-prover.md
572+
- Deploy Type 1 Prover on devnet: cdk/how-to/deploy-t1-prover-devnet.md
573+
- Architecture:
574+
- Overview: cdk/architecture/type-1-prover/t1-architecture.md
575+
- Type 1 design challenges: cdk/architecture/type-1-prover/t1-design-challenge.md
576+
- Tests and proving costs: cdk/architecture/type-1-prover/testing-and-proving-costs.md
577+
- Specification:
578+
- CPU component: cdk/architecture/type-1-prover/t1-cpu-component.md
579+
- CTL protocol: cdk/architecture/type-1-prover/t1-ctl-protocol.md
580+
- Range checks: cdk/architecture/type-1-prover/t1-rangechecks.md
578581
- Polygon protocols: learn/polygon-protocols.md
579582
- Demystifying reorgs: https://polygon.technology/blog/reorgs-demystified-insights-from-monitoring-with-a-sensor-network
580583

0 commit comments

Comments
 (0)