Skip to content

Update README.md#193

Open
riteshkakkad wants to merge 2 commits intoXinFinOrg:masterfrom
riteshkakkad:patch-1
Open

Update README.md#193
riteshkakkad wants to merge 2 commits intoXinFinOrg:masterfrom
riteshkakkad:patch-1

Conversation

@riteshkakkad
Copy link
Contributor

@riteshkakkad riteshkakkad commented Feb 21, 2026

update ReadeMe file

Proposed changes

Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.

Types of changes

What types of changes does your code introduce to XDC network?
Put an in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [✅] Documentation Update (if none of the other choices apply)
  • Regular KTLO or any of the maintaince work. e.g code style
  • CICD Improvement

Impacted Components

Which part of the codebase this PR will touch base on,

Put an in the boxes that apply

  • Consensus
  • Account
  • Network
  • Geth
  • Smart Contract
  • External components
  • Not sure (Please specify below)

Checklist

Put an in the boxes once you have confirmed below actions (or provide reasons on not doing so) that

  • This PR has sufficient test coverage (unit/integration test) OR I have provided reason in the PR description for not having test coverage
  • Provide an end-to-end test plan in the PR description on how to manually test it on the devnet/testnet.
  • Tested the backwards compatibility.
  • Tested with XDC nodes running this version co-exist with those running the previous version.
  • Relevant documentation has been updated as part of this PR
  • N/A

Summary by CodeRabbit

  • Documentation
    • Updated README with enhanced description of blockchain features
    • Added new Guide link to overview page
    • Added Video Demo section with setup guide reference

update ReadeMe file
@coderabbitai
Copy link

coderabbitai bot commented Feb 21, 2026

📝 Walkthrough

Walkthrough

README.md documentation updated with marketing-oriented content describing private, restricted-access blockchains. Added new "Guide" link, introduced "Video Demo" section header with promotional title "XDC Subnet Setup Made EASY in 10 Minutes" above existing YouTube link. Retained and reformatted "Deploying the Subnet" section.

Changes

Cohort / File(s) Summary
Documentation Update
README.md
Replaced initial descriptor with marketing-focused content about private blockchains, added new Guide link, introduced Video Demo section header with promotional title line, and updated section formatting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hops through the garden of documentation bright,
Marketing flourishes now catch the light,
A Video Demo header springs to view,
Guides and promotion—refreshingly new!
The README blooms with easier sight! 🌿✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is vague and generic. It uses the non-descriptive term 'Update README.md' without conveying what specific changes were made to the README. Use a more specific title that describes the actual content changes, such as 'Update README.md with XDC Subnet overview and video demo guide'.
Description check ❓ Inconclusive The description follows the required template structure and marks the correct change type (Documentation Update), but the 'Proposed changes' section is empty, lacking explanation of why these README updates should be accepted. Fill in the 'Proposed changes' section with a clear explanation of what was updated in the README and why these changes improve the documentation.
✅ Passed checks (1 passed)
Check name Status Explanation
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
  • 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.

Copy link

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 9-11: In the "Video Demo" section replace the separate title and
bare URL with a single Markdown hyperlink by merging "XDC Subnet Setup Made EASY
in 10 Minutes" and its URL into the format [XDC Subnet Setup Made EASY in 10
Minutes](https://www.youtube.com/watch?v=-SXsRbn6hN8); update the README's
"Video Demo" block so the title is the clickable link and remove the
now-redundant plain URL.
- Line 3: Replace the plain-text label and bare URL "Guide:
https://docs.xdc.network/subnet/overview/" with a Markdown hyperlink by
converting the label into link text and wrapping the URL in parentheses (e.g.,
change the line to use "[Guide](https://docs.xdc.network/subnet/overview/)" or
"[Subnet Overview](https://docs.xdc.network/subnet/overview/)") so the link
renders as a clickable Markdown link in README.md.

Documentation for XDC Subnet can be found here
https://docs.xdc.network/subnet/
Build private Block chains with XDC Subnet: Total data & transaction privacy, access restricted to authorized users only. No public exposure – checkpoints borrow XDC mainnet security. Perfect for banks, governments, healthcare & confidential enterprise apps.
Guide: https://docs.xdc.network/subnet/overview/
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Format the Guide link as a proper Markdown hyperlink.

Guide: <url> is a plain-text label and bare URL. On some Markdown renderers the label text won't be clickable. Use a standard Markdown link instead.

✏️ Proposed fix
-Guide: https://docs.xdc.network/subnet/overview/ 
+[Guide](https://docs.xdc.network/subnet/overview/)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Guide: https://docs.xdc.network/subnet/overview/
[Guide](https://docs.xdc.network/subnet/overview/)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 3, Replace the plain-text label and bare URL "Guide:
https://docs.xdc.network/subnet/overview/" with a Markdown hyperlink by
converting the label into link text and wrapping the URL in parentheses (e.g.,
change the line to use "[Guide](https://docs.xdc.network/subnet/overview/)" or
"[Subnet Overview](https://docs.xdc.network/subnet/overview/)") so the link
renders as a clickable Markdown link in README.md.

Comment on lines +9 to 11
## Video Demo
XDC Subnet Setup Made EASY in 10 Minutes
https://www.youtube.com/watch?v=-SXsRbn6hN8
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Combine the video title and URL into a single Markdown hyperlink.

Line 10 is an unlinked plain-text title sitting above the bare URL on line 11. The intent is clearly to describe the linked video, so they should be merged into one Markdown hyperlink.

✏️ Proposed fix
 ## Video Demo
-XDC Subnet Setup Made EASY in 10 Minutes
-https://www.youtube.com/watch?v=-SXsRbn6hN8
+[XDC Subnet Setup Made EASY in 10 Minutes](https://www.youtube.com/watch?v=-SXsRbn6hN8)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 9 - 11, In the "Video Demo" section replace the
separate title and bare URL with a single Markdown hyperlink by merging "XDC
Subnet Setup Made EASY in 10 Minutes" and its URL into the format [XDC Subnet
Setup Made EASY in 10 Minutes](https://www.youtube.com/watch?v=-SXsRbn6hN8);
update the README's "Video Demo" block so the title is the clickable link and
remove the now-redundant plain URL.

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