0xpolygon / polygon-docs

Polygon Technical Docs

Polygon Knowledge Layer

Welcome to the Polygon Knowledge Layer.

These docs use the Material theme for MkDocs. Our goal is to establish a high-quality, curated, and comprehensive "source of truth" for Polygon's technology.

This includes sections on:

• Polygon CDK
• Polygon zkEVM
• Polygon PoS
• Polygon Miden
• Developer tools

Run locally

Prerequisites

1. Python 3.12.
2. virtualenv: Install using pip3 install virtualenv.

Setup

1. Clone the repository.
2. cd to the root.
3. Run the run.sh script. You may need to make the script executable: chmod +x run.sh

./run.sh

The site comes up at http://127.0.0.1:8000/

Docker

If you prefer Docker, you can build and run the site using the following commands:

docker build -t polygon-docs .
docker compose up

Contributing

Getting started

1. Fork and branch: Fork the main branch into your own GitHub account. Create a feature branch for your changes.
2. Make changes: Implement your changes or additions in your feature branch.
3. Contribution quality: Ensure that your contributions are:
   • Atomic: Small, self-contained, logical updates are preferred.
   • Well documented: Use clear commit messages. Explain your changes in the pull request description.
   • Tested: Verify your changes do not break existing functionality.
   • Styled correctly: Follow the Microsoft Style Guide.

Creating a pull request

1. Pull request: Once your changes are complete, create a pull request against the main branch of Polygon Knowledge Layer.
2. Review process: Your pull request will be reviewed by the maintainers. They may request changes or clarifications.
3. Responsibility: Contributors are expected to maintain their contributions over time and update them as necessary to ensure continued accuracy and relevance.

Best practices

• Stay informed: Keep up-to-date with the latest developments in Polygon technologies.
• Engage with the community: Participate in discussions and provide feedback on other contributions.
• Stay consistent: Ensure your contributions are coherent with the rest of the documentation and do not overlap or contradict existing content.

Contact and support

• For docs issues (technical or language) open an issue here.
• For technical issues with the software, either raise an issue here and we will follow up, or check https://support.polygon.technology/support/home.

The team

• Anthony Matlala (@EmpieichO)
• Katharine Murphy (@kmurphypolygon)
• Hans (@hsutaiyu)

polygon-docs's Issues

Hi @dylanzkl

          Hi @dylanzkl 

We're looking into this for you.

Please be aware we just updated our whole doc site so we are expecting to be making a lot of fixes in the next weeks. Please be patient with us.

I will raise a ticket for this one.

Thank you.

Originally posted by @kmurphypolygon in #109 (comment)

Open

https://github.com/krylov-krylov/polygon-docs/actions/runs/7356392548/job/20026989365#step:4:1

Broken DNS record for "mapper.polygon.technology"

Hello.
I am reading manual how to Map token from Ethereum to Polygon network - https://docs.polygon.technology/pos/how-to/bridging/ethereum-polygon/submit-mapping-request/

Doc says:
In order to map tokens between Ethereum and Polygon PoS, you may use the Polygon Token Mapper.

But mapper.polygon.technology DNS record is missing

Could you fix manual or fix DNS record?

Thank you!

config file of zkevm-bridge-service missing when deploy zkevm

I'm deploying a polygon zkEVM following this official guide. But I can't start up the zkevm-bridge-service due to config file missing and I can't find any clue in the docs to guide me to figure out how to config the zkevm-bridge-service.

Mint NFT guide is outdated

Hello,
The Mint NFT guide (https://docs.polygon.technology/tools/storage/nftstorage/#deploy-the-smart-contract-to-polygon) is out of date.

It uses openzeppelin 4.x, where 5.x is available, which introduced breaking changes; and uses almost 2 years old solidity version.
This makes it hard for newcomers (like myself) to develop anything useful, as most of my time is spent on researching, how to migrate code from 4.x to 5.x.

I found both official hardhat, and openzeppelin documentation way more useful.

Best regards,
Maciej Błędkowski

Validium - Sepolia guide

Hey i found a few typos in validium sepolia guid
https://docs.polygon.technology/cdk/get-started/deploy-validium/node/run-node-services/#run-the-node

should be "cd ~/cdk-validium/cdk-data-availability" instead of cd ~/cdk-validium/cdk-data-availability-0.0.3

should be "cd /cdk-validium/zkevm-bridge-service-0.3.1" instead of cd "/cdk-validium/zkevm-bridge-service"

This one was cousing me problems with running the DAC -> https://docs.polygon.technology/cdk/get-started/deploy-validium/node/configure-deployment/#configure-the-dac

tomlq -i -t --arg CDK_VALIDIUM_ADDRESS "$CDK_VALIDIUM_ADDRESS" '.L1.CDKValidiumAddress = $CDK_VALIDIUM_ADDRESS' /tmp/cdk/dac-config.toml
tomlq -i -t --arg CDK_VALIDIUM_ADDRESS "$CDK_VALIDIUM_ADDRESS" '.L1.DataCommitteeAddress = $CDK_VALIDIUM_ADDRESS' /tmp/cdk/dac-config.toml

here its twice CDK_VALIDIUM_ADDRESS instead of DataCommitteeAddress

https://docs.polygon.technology/cdk/get-started/deploy-validium/node/configure-deployment/#configure-bridge-service

tomlq -i -t --arg CDK_DATA_COMMITTEE_CONTRACT_ADDRESS "$CDK_DATA_COMMITTEE_CONTRACT_ADDRESS" '.NetworkConfig.L2PolygonBridgeAddresses = [$CDK_DATA_COMMITTEE_CONTRACT_ADDRESS]' /tmp/cdk/bridge-config.toml

here CDK_DATA_COMMITTEE_CONTRACT_ADDRESS is mapped to L2PolygonBridgeAddresses instead of the bridge

Crossmint guide is missing from the new Polygon PoS docs

I wrote a PR that got merged by @cerberushades which added Crossmint as one of the tools to deploy a Smart Contract on Polygon.

It seems like it is missing after the migration was done.

https://docs.polygon.technology/pos/how-to/smart-contracts/

Would it be possible for you to recover my old PR and add it here or do I have to make another PR?

Polygons

whitepaper-v2.pdf

P2p B2b

POWER OF ETF