docs: update readme with new protocol contract directories #3011
Conversation
lumtis
requested review from
brewmaster012,
kingpinXD,
ws4charlie,
skosito,
swift1337 and
fbac
as code owners
📝 WalkthroughWalkthroughThe Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
readme.md (3)
22-28: Enhance markdown formatting and clarity.The content provides a clear overview of ZetaChain's core components. However, there are two areas for improvement:
- Unordered list style: Use consistent list markers for better markdown formatting.
- Wording: Consider a minor adjustment to enhance clarity.
Please apply the following changes:
This repository contains the core components: -* [Blockchain Modules (ZetaCore)](x): +- [Blockchain Modules (ZetaCore)](x): This section contains the core logic of the ZetaChain blockchain, built using Cosmos SDK modules. These modules are responsible for managing the state, state transitions, and overall functionality of the ZetaChain network. -* [ZetaClient](zetaclient): -The ZetaClient is a specialized client designed to act as an observer and signer for the ZetaChain network. It is responsible for communicating with the blockchain, relaying messages, and performing signature tasks to ensure the network operates cross-chain transactions. +- [ZetaClient](zetaclient): +The ZetaClient is a specialized client designed to act as an observer and signer for the ZetaChain network. It is responsible for communicating with the blockchain, relaying messages, and performing signature tasks to facilitate cross-chain transactions.🧰 Tools
🪛 Markdownlint
24-24: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
26-26: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-37: Refine markdown formatting and enhance conciseness.The new "Protocol Contracts" section provides valuable information about ZetaChain's smart contract repositories. To improve this section:
- Unordered list style: Use consistent list markers for better markdown formatting.
- Conciseness: The last paragraph can be more succinct.
Please apply the following changes:
### Protocol Contracts In addition to the blockchain codebase, ZetaChain's architecture includes a set of protocol contracts that serve as an interface for developers to interact with the blockchain. These smart contracts are deployed across various blockchain networks. The smart contract source code is maintained in separate repositories, depending on the network they are deployed on: -* [ZetaChain EVM and EVM connected chains](https://github.com/zeta-chain/protocol-contracts) -* [Solana connected chains (SVM)](https://github.com/zeta-chain/protocol-contracts-solana) -* [TON connected chains (TVM)](https://github.com/zeta-chain/protocol-contracts-ton) +- [ZetaChain EVM and EVM connected chains](https://github.com/zeta-chain/protocol-contracts) +- [Solana connected chains (SVM)](https://github.com/zeta-chain/protocol-contracts-solana) +- [TON connected chains (TVM)](https://github.com/zeta-chain/protocol-contracts-ton) -These repositories contain the necessary code and tools to deploy, interact with, and extend the functionality of ZetaChain's cross-chain protocol on each respective blockchain network. +These repositories contain the code and tools for deploying, interacting with, and extending ZetaChain's cross-chain protocol on respective blockchain networks.🧰 Tools
🪛 Markdownlint
33-33: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
34-34: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
35-35: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
Line range hint
38-93: Approve unchanged sections and enhance "Further Reading".The unchanged sections on building binaries and making source code changes provide valuable information for developers. The new "Further Reading" section is a welcome addition, offering links to additional documentation.
Consider enhancing the "Further Reading" section by adding a brief description for each link:
## Further Reading Find below further documentation for development and running your own ZetaChain node: -- [Run the E2E tests and interact with the localnet](docs/development/LOCAL_TESTING.md) -- [Make a new ZetaChain release](docs/development/RELEASES.md) -- [Deploy your own ZetaChain or Bitcoin node](docs/development/DEPLOY_NODES.md) +- [Run the E2E tests and interact with the localnet](docs/development/LOCAL_TESTING.md): Learn how to set up and test ZetaChain in a local environment. +- [Make a new ZetaChain release](docs/development/RELEASES.md): Understand the process of creating and managing ZetaChain releases. +- [Deploy your own ZetaChain or Bitcoin node](docs/development/DEPLOY_NODES.md): Step-by-step guide for deploying ZetaChain or Bitcoin nodes.🧰 Tools
🪛 Markdownlint
24-24: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
26-26: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
33-33: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
34-34: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
35-35: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- readme.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
readme.md
24-24: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
26-26: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
33-33: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
34-34: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
35-35: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
🔇 Additional comments (1)
readme.md (1)
Line range hint
1-93: Approve README changes with commendation.The restructuring and content enhancements in this README significantly improve its clarity and usefulness for developers. Key improvements include:
- Enhanced introduction emphasizing ZetaChain's capabilities.
- Clear organization of ZetaChain components.
- New "Protocol Contracts" section providing valuable links to smart contract repositories.
- Addition of a "Further Reading" section with links to additional documentation.
These changes offer a more comprehensive overview of ZetaChain and its development ecosystem. The minor suggestions provided in previous comments will further refine the document's formatting and conciseness.
Overall, excellent work on improving the README. These changes will greatly benefit developers working with ZetaChain.
🧰 Tools
🪛 Markdownlint
24-24: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
26-26: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
33-33: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
34-34: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
35-35: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
Description
Update the readme to add link to Solana and TON contracts
Summary by CodeRabbit
readme.mdfor improved clarity on ZetaChain's capabilities.