Update setup guide with validator requirements #319

sirouk · 2025-12-13T05:18:54Z

Added information about staking deposit and validator priming transaction requirements.

Summary by CodeRabbit

Documentation
- Clarified validator setup requirements regarding staking deposits and setup prerequisites in the setup guide.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Added information about staking deposit and validator priming transaction requirements.

netlify · 2025-12-13T05:18:59Z

❌ Deploy Preview for genlayer-docs failed. Why did it fail? →

Name	Link
🔨 Latest commit	`fd5a910`
🔍 Latest deploy log	https://app.netlify.com/projects/genlayer-docs/deploys/693cf740598ee60008e1fa5c

coderabbitai · 2025-12-13T05:19:03Z

Walkthrough

This pull request adds a single clarifying sentence to the validator setup guide documentation: "Validators require both a staking deposit and a validator priming transaction to enter the set." This emphasizes the dual requirement without altering existing content or structure.

Changes

Cohort / File(s)	Summary
Documentation Update `pages/validators/setup-guide.mdx`	Added clarifying sentence about dual validator requirements (staking deposit and priming transaction)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

genlayerlabs/genlayer-docs#309: Expands validator staking and priming guides; related through shared focus on validator setup and priming transaction requirements.

Suggested reviewers

rasca
MuncleUscles

Poem

🐰 A validator's journey, now crystal and clear,
Two steps to join, hold both dear—
Stack coins and prime the transaction true,
The setup guide whispers wisdom anew! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: adding validator requirements information to the setup guide documentation.
Description check	✅ Passed	The description is minimal but appropriately captures the specific change made. However, it does not follow the Conventional Commits format specified in the template.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

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 and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

pages/validators/setup-guide.mdx (1)

5-9: Clarify terminology + point to where/how the “priming transaction” happens

The new sentence is useful, but “enter the set” and “validator priming transaction” read a bit undefined here. Consider (a) naming it as “active validator set” (if that’s what you mean) and (b) adding a short pointer to the exact step/command (e.g., wizard step or a dedicated validator-join/priming section) so readers know how to satisfy the requirement without hunting. (Based on retrieved learnings for pages/validators/setup-guide.mdx doc accuracy expectations.)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1895087 and fd5a910.

📒 Files selected for processing (1)

pages/validators/setup-guide.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

pages/**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files

Files:

pages/validators/setup-guide.mdx

pages/validators/setup-guide.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases

Files:

pages/validators/setup-guide.mdx

🧠 Learnings (10)

📓 Common learnings

Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur

Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases

Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur

Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur

Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable

Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur

Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur

Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands

Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands