Skip to content

docs: add Polkadot & Kusama section - #36

Open
benceharomi wants to merge 1 commit into
mainfrom
docs/polkadot-kusama-section
Open

docs: add Polkadot & Kusama section#36
benceharomi wants to merge 1 commit into
mainfrom
docs/polkadot-kusama-section

Conversation

@benceharomi

Copy link
Copy Markdown
Member

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-grant branches on GitHub, which nobody browsing the docs would find.

What this adds

A landing page at /kusama/ covering:

  • The DKIM registry deployed on Paseo Asset Hub, and how its keys are kept current automatically
  • Creating a blueprint that targets Polkadot Hub Testnet, which deploys the verifier for you
  • Verifying proofs on-chain with verifyProofOnChain
  • Deploying a verifier yourself, for anyone who wants one they control
  • Chain and contract reference, at the end rather than in the middle
  • Links out to the per-repo engineering docs rather than duplicating them
  • A closing note on the standalone PolkaVM Hardhat template published for the wider Polkadot community

Plus 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:

  • Paseo support in verifyProofOnChain ships in the nightly SDK release; stable verifies against Base Sepolia only
  • Chain selection is currently available on the staging registry

Both 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 (no resolc-aware verify task), and the page explains that so nobody thinks their own deployment went wrong.

Notes for review

  • Entirely additive: 131 insertions, 0 deletions
  • yarn build passes, which with onBrokenLinks: 'throw' means every internal link resolves; broken anchors are also clean
  • All external links were verified to resolve
  • The navbar goes from 4 items to 5. If that crowds at narrow widths, dropping the navbar entry and keeping the sidebar one is a one-line change
  • Local preview needs Node <= 22 and POSTHOG_API_KEY set to any value

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.
@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Important

Review available on request

  • 🔍 Trigger review

Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment @coderabbitai review to review the latest changes. For a full review, comment @coderabbitai full review.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ec99247c-ae01-42fc-be72-799898ed2bbe


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@claude

claude Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Claude encountered an error —— View job


I'll analyze this and get back to you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants