docs(developers): add delegator, bridging, and exchange/wallet integrator guides#434
docs(developers): add delegator, bridging, and exchange/wallet integrator guides#434MuncleUscles wants to merge 1 commit into
Conversation
Add three user/integrator-facing pages under pages/developers and wire them into the developers _meta.json navigation: - delegating-gen.mdx — end-user (non-CLI-first) delegator guide: choose a validator (explorer Validators view + `genlayer staking validators`), delegate, monitor/claim rewards, and switch validators. Documents that switching is NOT atomic (exit -> 7-epoch unbonding -> claim -> rejoin; no redelegate) and the epoch-0 relaxed rules. Cross-links the Genesis Epoch 0 section and staking concepts/guide. - bridging-gen.mdx — practical L1<->L2 bridging how-to: deposit L1->L2, withdraw L2->L1, zkSync-style finalization timing (batch must finalize on L1 before a withdrawal can be proven; ~1h expectation on real networks), and how to track a transfer. Bridge routes/addresses left network-specific (points at Networks), no addresses invented. - exchange-wallet-integration.mdx — exchange/wallet/indexer onboarding: chain model, chain IDs/RPC/WS, 0x address format, native GEN vs L1 representation, deposit detection, and conservative finality guidance. Points at Networks and the Node API for canonical values. Also fix two stale `#staking-operations-testnet` anchors in staking-guide.mdx (real heading slug is `#staking-operations`) and add cross-links to the new delegator guide.
✅ Deploy Preview for genlayer-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reached
Next review available in: 48 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
1 participant
Description
Adds three new user- and integrator-facing documentation pages under
pages/developers/, wired into thedevelopers_meta.jsonnavigation and cross-linked with existing pages. All facts are sourced from the existing docs (networks, staking-guide, setup-guide, node API, finality/rollup concepts) — no addresses, chain IDs, or timings were invented.New pages
delegating-gen.mdx—Delegating GEN: A Delegator's Guide(/developers/delegating-gen). End-user, non-CLI-first walkthrough: choose a validator (explorer Validators view +genlayer staking validators), delegate, monitor and claim rewards, and switch validators. Accuracy-critical points captured: switching is not atomic (exit → ~7-epoch unbonding → claim → re-delegate to the new validator; there is no redelegate), delegations activate +2 epochs, exits are in shares not tokens, and epoch-0 bootstrap rules (free / below-minimum allowed, normal rules from epoch 2). Cross-links the Genesis Epoch 0 section and the staking concept/guide pages.bridging-gen.mdx—Bridging GEN (L1 ↔ L2)(/developers/bridging-gen). Practical how-to for deposits (L1→L2) and withdrawals (L2→L1), with zkSync-style finalization timing (an L2→L1 message can only be proven after the L2 batch finalizes on Ethereum — on the order of an hour on real networks, framed as an expectation, not a guarantee) and how to track a transfer on both layers. Bridge routes/addresses are explicitly left network-specific and point to the Networks page; the L2→L1 settlement clock is kept distinct from GenLayer's appeal/Finality Window.exchange-wallet-integration.mdx—Exchange & Wallet Integrator Guide(/developers/exchange-wallet-integration). For exchanges/wallets/indexers: two-layer chain model, chain IDs / RPC / WS,0xaddress format, native GEN vs. its L1 representation, deposit detection, and conservative finality guidance. Points at the canonical Networks page and Node API for concrete values rather than duplicating them.Also (scout fix)
#staking-operations-testnetanchors instaking-guide.mdx— the real heading slug on the CLI reference is#staking-operations(the-testnetanchor matched no heading and landed at page top). Added cross-links fromstaking-guide.mdxto the new delegator guide.Release Notes
New docs: a delegator's guide (delegate/monitor/claim/switch GEN), an L1↔L2 bridging how-to, and an exchange/wallet/indexer integrator guide. Fixed a broken CLI-staking anchor in the Staking Contract Guide.
Types of Changes
Checklist
scripts/list-docs-routes.js— 152 → 155 routes; all three new routes present)scripts/generate-full-docs.js— per-page.mdmirrors +llms.txtentries generated for all three)pages/developers/_meta.jsonand cross-linked