Skip to content

Update README.md#253

Open
vrushalipanchal wants to merge 1 commit intoXinFinOrg:masterfrom
vrushalipanchal:patch-2
Open

Update README.md#253
vrushalipanchal wants to merge 1 commit intoXinFinOrg:masterfrom
vrushalipanchal:patch-2

Conversation

@vrushalipanchal
Copy link
Copy Markdown
Contributor

@vrushalipanchal vrushalipanchal commented Mar 23, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive "XDC Network Masternodes" section covering masternode roles, rewards distribution, and slashing mechanisms.
    • Updated setup instructions with refreshed branding and reorganized methods.
    • Updated social media link reference.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026

📝 Walkthrough

Walkthrough

Updated README.md documentation to reflect XDC Network branding, replacing XinFin references with XDC. Added a new "XDC Network Masternodes" section detailing validator roles, rewards distribution, and slashing. Restructured setup instructions with labeled methods and updated social media links.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added "XDC Network Masternodes" section covering validator/standby roles, epoch-based rewards, and slashing. Replaced "How to Setup XinFin Masternode" with "How to Setup XDC Masternode." Updated method labels and XinFin → XDC terminology throughout. Modified Twitter/X social link from x.com/XDC_Network_ to x.com/XDCNetwork.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • AnilChinchawale

Poem

🐰✨ A masternode tale we now share,
With XDC methods beyond compare,
From epochs to slashing, rewards flow so bright,
Our docs hop and dance in the spring morning light! 🌟

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update README.md' is vague and generic, using non-descriptive phrasing that doesn't convey meaningful information about the specific changes made to the README. Use a more specific title that describes the main change, such as 'Update XDC masternode documentation in README' or 'Rebrand XinFin to XDC Network in README'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (2)
README.md (2)

251-251: Normalize heading style (ATX vs ATX-closed).

Line 251 and Line 296 use trailing ###, which is inconsistent with the rest of the file and triggers MD003.

Proposed doc fix
-### Method 1: Setup XDC Masternode using Bootstrap Script ###
+### Method 1: Setup XDC Masternode using Bootstrap Script

-### Method 2: Setup XDC Masternode with Docker ###
+### Method 2: Setup XDC Masternode with Docker

Also applies to: 296-296

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 251, Normalize heading style by removing trailing closing
hashes from ATX-closed headings: update the "### Method 1: Setup XDC Masternode
using Bootstrap Script ###" (and the corresponding "Method 2" heading) to use
standard ATX format without trailing `###` (e.g., "### Method 1: Setup XDC
Masternode using Bootstrap Script") so the file consistently uses ATX headings
and resolves MD003 warnings.

4-4: Use descriptive link text instead of “Read more here.”

Line 4, Line 9, and Line 52 use generic link text, which hurts readability/accessibility and triggers MD059.

Proposed doc fix
-Read more [here](https://docs.xdc.network/xdcchain/developers/node_operators/masternode/)
+Read more in the [XDC Masternode Operator Guide](https://docs.xdc.network/xdcchain/developers/node_operators/masternode/)

-Read more [here](https://docs.xdc.network/xdcchain/rewards)...
+Read more in the [XDC Rewards Documentation](https://docs.xdc.network/xdcchain/rewards).

-Read more [here](https://docs.xdc.network/xdcchain/developers/node_operators/slashing/)
+Read more in the [XDC Slashing Documentation](https://docs.xdc.network/xdcchain/developers/node_operators/slashing/)

Also applies to: 9-9, 52-52

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 4, Replace the generic "Read more [here]" link text at the
three occurrences noted (the links around the XDC masternode documentation and
the two other similar links) with descriptive link text that explains the
target, e.g., "XDC Masternode operator guide" (or a similarly specific phrase)
so the link text is meaningful and accessible; update the link labels where the
anchor currently reads "here" (the occurrences near the masternode docs and the
two other instances) to use those descriptive phrases while keeping the original
URLs unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 251: Normalize heading style by removing trailing closing hashes from
ATX-closed headings: update the "### Method 1: Setup XDC Masternode using
Bootstrap Script ###" (and the corresponding "Method 2" heading) to use standard
ATX format without trailing `###` (e.g., "### Method 1: Setup XDC Masternode
using Bootstrap Script") so the file consistently uses ATX headings and resolves
MD003 warnings.
- Line 4: Replace the generic "Read more [here]" link text at the three
occurrences noted (the links around the XDC masternode documentation and the two
other similar links) with descriptive link text that explains the target, e.g.,
"XDC Masternode operator guide" (or a similarly specific phrase) so the link
text is meaningful and accessible; update the link labels where the anchor
currently reads "here" (the occurrences near the masternode docs and the two
other instances) to use those descriptive phrases while keeping the original
URLs unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 14bfb46a-32e5-4870-8146-edb5f1e7d113

📥 Commits

Reviewing files that changed from the base of the PR and between fd214a3 and d5db1f2.

📒 Files selected for processing (1)
  • README.md

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.

1 participant