fix: update add a network, join by invitation code docs #74
Conversation
ENG-52 Update "Join by invitation code" resources
|
WalkthroughThe documentation has been updated to improve clarity and precision in instructions for connecting to external blockchain networks and managing validator nodes. Key terminology has been revised, and new guidance has been introduced for integrating with platforms like SettleMint, including detailed steps and prerequisites. Changes
Poem
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
CodeRabbit Configuration File (
|
Reviewer's Guide by SourceryThis pull request updates the documentation for adding a network to an application and joining a network by invitation code. It clarifies the process, improves the structure, and adds information about connecting to external networks. File-Level Changes
Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @snigdha920 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
snigdha920
changed the title
…update-join-by-invitation-code-resources
There was a problem hiding this comment.
Hey @snigdha920 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md
Outdated
Show resolved
Hide resolved
commit d541875 Author: Snigdha Singh <snigdha920@gmail.com> Date: Wed Sep 11 13:26:50 2024 +0200 use stable link commit 7b94aa5 Author: Snigdha Singh <snigdha920@gmail.com> Date: Tue Sep 10 17:31:40 2024 +0200 cursor ai improvements commit fab9c6e Author: Snigdha Singh <snigdha920@gmail.com> Date: Tue Sep 10 17:18:54 2024 +0200 fix link to qbft_proposeValidatorVote commit 1750ec3 Author: Snigdha Singh <snigdha920@gmail.com> Date: Tue Sep 10 17:17:10 2024 +0200 fix page number, json rpc method name, grammar commit f192b18 Author: Snigdha Singh <snigdha920@gmail.com> Date: Tue Sep 10 14:51:50 2024 +0200 remove note that platform doesn't reflect node type changes commit e99a736 Author: Snigdha Singh <snigdha920@gmail.com> Date: Tue Sep 10 14:51:01 2024 +0200 remove references to images commit 568e6e4 Author: Snigdha Singh <snigdha920@gmail.com> Date: Tue Sep 10 14:32:17 2024 +0200 more cleanup commit f358c84 Author: Snigdha Singh <snigdha920@gmail.com> Date: Tue Sep 10 13:06:01 2024 +0200 initial docs
![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)
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (2)
32-32: Consider rephrasing "a majority of" to improve conciseness.The static analysis tool suggests that the phrase "a majority of" might be wordy and could be replaced with a shorter alternative. While the current phrasing is clear and understandable, you may consider rephrasing it to improve conciseness. For example:
-Once a majority of validators are running on the platform, +Once most validators are running on the platform,Tools
LanguageTool
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidator) to make it a validator. Once a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...xternal validators. We recommend having a majority of validators running on the platform for ...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
36-36: Consider rephrasing "a majority of" to improve conciseness.The static analysis tool suggests that the phrase "a majority of" might be wordy and could be replaced with a shorter alternative. While the current phrasing is clear and understandable, you may consider rephrasing it to improve conciseness. For example:
-Unless a majority of validators are running on the platform, +Unless most validators are running on the platform,Tools
LanguageTool
[style] ~36-~36: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...he network. ## Add a Validator Unless a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md (1)
138-138: LGTM, but consider adding a comma.The change in the reference to the voting function is approved.
However, consider adding a comma after the word "Similarly" to improve readability:
Similarly, you can make a platform validator a regular node by executing [qbft_proposeValidatorVote](https://besu.hyperledger.org/stable/private-networks/reference/api#qbft_proposevalidatorvote) with proposal "false" on every validator node.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md (2 hunks)
- docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (1 hunks)
Additional context used
LanguageTool
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidator) to make it a validator. Once a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...xternal validators. We recommend having a majority of validators running on the platform for ...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~36-~36: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...he network. ## Add a Validator Unless a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md
[uncategorized] ~137-~137: A comma may be missing after the conjunctive/linking adverb ‘Similarly’.
Context: ...etworks/reference/api#admin_nodeinfo). Similarly you can make a platform validator a reg...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Additional comments not posted (7)
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md (5)
5-10: LGTM!The prerequisites section is clear and provides the necessary information for the user to proceed with the instructions.
11-22: LGTM!The "Joining a Network" section provides clear step-by-step instructions for joining a permissioned network. The references to other documentation provide additional context and information for the user.
23-33: LGTM!The "Adding Nodes" section provides clear instructions for adding nodes to the network. The differentiation between validator and non-validator nodes is important and clearly explained. The requirement for a majority of validators to be running on the platform is also clearly stated.
Tools
LanguageTool
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...alidator) to make it a validator. Once a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
[style] ~32-~32: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...xternal validators. We recommend having a majority of validators running on the platform for ...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
34-43: LGTM!The "Add a Validator" section provides clear instructions for adding a platform node as a validator. The differentiation between the process for Hyperledger Besu and Quorum is important and clearly explained. The requirement for a majority of validators to be running on the platform to add a platform node as a validator without voting on external validators is also clearly stated.
Tools
LanguageTool
[style] ~36-~36: ‘a majority of’ might be wordy. Consider a shorter alternative.
Context: ...he network. ## Add a Validator Unless a majority of validators are running on the platform,...(EN_WORDINESS_PREMIUM_A_MAJORITY_OF)
45-68: LGTM!The "Remove a Validator" section provides clear instructions for removing a platform validator. The differentiation between the process for Hyperledger Besu and Quorum is important and clearly explained. The "Node Type Conflict Warning" section provides a clear explanation of the warning and instructions for resolving it.
docs/blockchain-guides/1_Hyperledger-Besu/8_enterprise-ethereum-connect-external-node.md (2)
1-1: LGTM!The change in the title is approved.
136-136: The previous review comment is still valid and applicable.
snigdha920
deleted the
snigdha/eng-52-update-join-by-invitation-code-resources
branch
Branches from: #73
Summary by Sourcery
Revise and expand the documentation for adding networks to applications, joining networks by invitation code, and connecting to external networks and nodes. Introduce a new guide for integrating with external networks using the SettleMint platform, and update existing guides with clearer instructions and updated API references.
Documentation:
Summary by CodeRabbit
Summary by CodeRabbit