Update README.MD #16
Update README.MD #16
Conversation
Changes: Fixed typos, standardized formatting, improved clarity, and consistent capitalization.
WalkthroughThe pull request updates README.MD with editorial and formatting changes: adds a "Description of Changes" section, rewrites multiple phrases for consistency (including pluralizations), standardizes capitalization and Markdown styling, converts several sections to bulleted lists with Markdown links, reformats persistent peers as code-styled items, and refines the Testnet Oro description. No functional data, exported/public declarations, or external interfaces were modified. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
README.MD (3)
7-15: Move “Description of Changes” to PR body or CHANGELOGPer convention, change summaries belong in the PR description or a CHANGELOG, not in the README.
Apply this diff to remove the section:
-**Description of Changes:** - -* Fixed typos (e.g., “Rest” → “REST”, capitalization inconsistencies). -* Standardized formatting for endpoints and peer entries. -* Improved clarity and readability of sentences. -* Added consistent capitalization for headings and proper nouns. -* Updated phrasing to be more professional and concise. -* Fixed minor Markdown inconsistencies (extra spaces, bullet formatting). -
44-49: Prefer subheadings over bold for endpoint groupsUsing “#### Uno” and “#### Dos” improves navigability and ToC generation over bold text.
Apply this diff:
-**Uno**: +#### Uno @@ -**Dos**: +#### DosAlso applies to: 56-58
70-73: Fix capitalization in link labelUse “KiiChain” for consistency with branding.
Apply this diff:
-* [Discord Kiichain Invitation](https://discord.com/invite/kiichain) +* [Discord KiiChain Invitation](https://discord.com/invite/kiichain)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.MD(1 hunks)
🔇 Additional comments (8)
README.MD (8)
18-23: Nice clarity and structure for resourcesPluralization and concise bullets improve scanability.
26-29: Testnet description reads wellCrisp, accurate phrasing for EVM compatibility and use guidance.
50-53: Good: peers formatted as code in bulletsReadable and copy-paste friendly.
60-63: Good: second persistent peer formatting matches firstConsistent presentation across endpoint groups.
66-69: Faucet guidance is clear and usefulDirect links to Explorer faucet and guide are appreciated.
Also applies to: 74-77
30-33: ✅ Relative link verified in README.MDThe directory
./testnet_oro/exists, and the link at lines 30–33 in README.MD resolves correctly. No changes needed.
36-39: Docs link verified and approvedThe Testnet Oro documentation URL returns a 200 OK response, confirming it’s valid and accessible. Great addition to the README!
46-49: Verify README External Links and EndpointsThe automated HEAD checks produced the following HTTP statuses:
• https://rpc.uno.sentry.testnet.v3.kiivalidator.com → 200 OK
• https://lcd.uno.sentry.testnet.v3.kiivalidator.com → 501 Not Implemented (HEAD not supported)
• https://json-rpc.uno.sentry.testnet.v3.kiivalidator.com → 405 Method Not Allowed (HEAD not supported)
• https://rpc.dos.sentry.testnet.v3.kiivalidator.com → 200 OK
• https://lcd.dos.sentry.testnet.v3.kiivalidator.com → 501 Not Implemented (HEAD not supported)
• https://json-rpc.dos.sentry.testnet.v3.kiivalidator.com → 405 Method Not Allowed (HEAD not supported)
• https://docs.kiiglobal.io/docs/build-on-kiichain/testnet-oro → 200 OK
• https://explorer.kiichain.io/wallet/accounts → 404 Not Found
• https://discord.com/invite/kiichain → 200 OK
• https://docs.kiiglobal.io/docs/build-on-kiichain/developer-tools/testnet-faucet → 200 OKPlease address the following:
- Re-check the REST (LCD) and JSON-RPC endpoints with a GET request (many servers disallow HEAD) and update the README if the URLs have changed or are unreachable.
- Correct or replace the explorer link (
/wallet/accounts) which returns 404.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.MD (1)
3-11: Remove “Description of Changes” section from the README (belongs in PR body, not docs).This meta section is PR-specific and should not live in the repository’s README. Please remove it to keep the README focused on product/user-facing content.
Apply this diff:
-**Description of Changes:** - -* Fixed typos (e.g., “Rest” → “REST”, capitalization inconsistencies). -* Standardized formatting for endpoints and peer entries. -* Improved clarity and readability of sentences. -* Added consistent capitalization for headings and proper nouns. -* Updated phrasing to be more professional and concise. -* Fixed minor Markdown inconsistencies (extra spaces, bullet formatting). -
🧹 Nitpick comments (4)
README.MD (4)
14-14: Nit: Streamline the intro sentence to the list.“such as” is redundant since the list is comprehensive. This reads tighter:
-Here you will find resources such as: +This repository includes:
22-25: Trim redundancy and tighten Testnet Oro copy.Avoid repeating “EVM-compatible/compatibility” and keep one concise paragraph.
-KiiChain is a peer-to-peer, decentralized, EVM-compatible network built with the Cosmos SDK. The public testnet is called **KiiChain Testnet Oro**. - -Testnet Oro is the permanent testnet with smart contract functionality and EVM compatibility. All hackathons, builds, airdrops, and test deployments should be done on this network. +KiiChain is a peer-to-peer, decentralized network built with the Cosmos SDK and compatible with the EVM. The public, permanent testnet—**KiiChain Testnet Oro**—supports smart contracts and EVM execution. Use it for hackathons, builds, airdrops, and test deployments.
46-46: Use plural “Persistent peers” for forward-compatibility.Even when there’s a single entry, “peers” keeps headings consistent as more entries are added.
-Persistent peer: +Persistent peers:Also applies to: 56-56
68-68: Fix brand capitalization for “KiiChain”.Maintain consistent brand capitalization.
-* [Discord Kiichain Invitation](https://discord.com/invite/kiichain) +* [Discord KiiChain Invite](https://discord.com/invite/kiichain)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.MD(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.MD
[grammar] ~5-~5: There might be a mistake here.
Context: ...“REST”, capitalization inconsistencies). * Standardized formatting for endpoints an...
(QB_NEW_EN)
[grammar] ~16-~16: There might be a mistake here.
Context: ...find resources such as: * Genesis files * Onboarding scripts * General chain infor...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ...s: * Genesis files * Onboarding scripts * General chain information ## Testnet Or...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ...c.uno.sentry.testnet.v3.kiivalidator.com](https://rpc.uno.sentry.testnet.v3.kiivalidator.com) * REST (LCD): [https://lcd.uno.sentry.testnet.v3.kii...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ...d.uno.sentry.testnet.v3.kiivalidator.com](https://lcd.uno.sentry.testnet.v3.kiivalidator.com) * JSON-RPC (EVM): [https://json-rpc.uno.sentry.testnet.v...
(QB_NEW_EN)
[grammar] ~52-~52: There might be a mistake here.
Context: ...c.dos.sentry.testnet.v3.kiivalidator.com](https://rpc.dos.sentry.testnet.v3.kiivalidator.com) * REST (LCD): [https://lcd.dos.sentry.testnet.v3.kii...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ...d.dos.sentry.testnet.v3.kiivalidator.com](https://lcd.dos.sentry.testnet.v3.kiivalidator.com) * JSON-RPC (EVM): [https://json-rpc.dos.sentry.testnet.v...
(QB_NEW_EN)
[grammar] ~68-~68: Ensure spelling is correct
Context: ...hrough our Discord channel: * [Discord Kiichain Invitation](https://discord.com/invite/...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (1)
README.MD (1)
42-45: LGTM: Endpoint formatting is clear and consistent.Backticked labels and clickable links improve readability and copyability. No issues found.
Also applies to: 52-55
|
actions check |
2 participants
Changes: Fixed typos, standardized formatting, improved clarity, and consistent capitalization.
Description
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration