docs: add Polkadot & Kusama section - #36
Open
benceharomi wants to merge 1 commit into
Open
Conversation
The docs had no Polkadot, Kusama, PolkaVM or Paseo content, so a developer building on Kusama browsing docs.zk.email had no entry point into any of it. Adds a landing page at /kusama/ covering the DKIM registry deployed on Paseo Asset Hub and how its keys are kept current, creating a blueprint that targets Polkadot Hub Testnet, verifying proofs on-chain, and deploying a verifier by hand for anyone who wants one they control. Chain and address reference sits at the end. The page links out to the per-repo engineering docs rather than duplicating them. Anything not yet on a stable surface is labelled: Paseo support in verifyProofOnChain ships in the nightly SDK release, and chain selection is currently available on the staging registry. Also wires the section into the sidebar and navbar, and cross-links it from the ZK Email Verifier overview and the Blueprint SDK setup page.
|
Important Review available on request
Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The Kusama ZK bounty curators asked whether ZK Email would add a Kusama section to docs.zk.email, pointing out that a developer building on Kusama who browses these docs has no way to find the Polkadot/PolkaVM work.
That was accurate: the sitemap had 72 URLs and zero matches for polkadot, kusama, polkavm or paseo. Everything lived in per-repo
kusama-grantbranches on GitHub, which nobody browsing the docs would find.What this adds
A landing page at
/kusama/covering:verifyProofOnChainPlus a sidebar heading, a navbar entry, and one cross-link each from the ZK Email Verifier overview and the Blueprint SDK setup page.
Availability labelling
Some of this is not on a stable surface yet, so the page says so rather than implying it works today:
verifyProofOnChainships in the nightly SDK release; stable verifies against Base Sepolia onlyBoth labels can come out in a one-line follow-up once those ship.
The deployed contracts are listed with Blockscout links but are deliberately not described as source-verified. They report
is_verified: false, which is the known PolkaVM tooling gap (noresolc-aware verify task), and the page explains that so nobody thinks their own deployment went wrong.Notes for review
yarn buildpasses, which withonBrokenLinks: 'throw'means every internal link resolves; broken anchors are also cleanPOSTHOG_API_KEYset to any value