Improve docs #16
Improve docs #16
Conversation
WalkthroughThe pull request introduces a new node type, "Conduit node," to the Voi node setup, enhancing the documentation in Changes
Possibly related PRs
Tip OpenAI O1 model for chat
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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Files selected for processing (2)
- README.md (3 hunks)
- tools/utils/network_utils.go (1 hunks)
Additional context used
LanguageTool
README.md
[style] ~92-~92: Consider a shorter alternative to avoid wordiness.
Context: ... the conduit framework to the network, in order to query network such, such as looking up ...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~101-~101: Possible missing comma found.
Context: ... start. If you need to ensure it stays constant pre-create the folder and create a `alg...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
README.md
92-92: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
98-98: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
100-100: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
104-104: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
Additional comments not posted (4)
README.md (4)
12-12: LGTM!The addition of the "Conduit node" to the list of supported node types is clear and consistent with the rest of the changes in this PR.
33-38: LGTM!The instructions for running a node with default mainnet settings are a helpful addition to the documentation.
58-62: LGTM!The updated command for running a relay node with port mapping is clear and informative.
66-69: LGTM!The updated command for running an archiver node with a volume mount for data persistence is a helpful addition.
| Guidance on how to install Conduit and the Indexer can be found on the [Conduit GitHub page](https://github.com/algorand/conduit), | ||
| as well as the [Indexer GitHub page](https://github.com/algorand/indexer) | ||
| The API token required can be found in the folder that you have mounted via the `-v` flag, after | ||
| startup. | ||
|
|
||
| The API token is persistent and generated randomly on first start. If you need to ensure it | ||
| stays constant pre-create the folder and create a `algod.token` and `algod.admin.token` file with the wanted sha256 tokens inside. | ||
|
|
There was a problem hiding this comment.
Remove trailing spaces.
The instructions for obtaining the API token required for the conduit node are a valuable addition to the documentation.
However, please remove the trailing spaces in lines 98 and 100 to adhere to the Markdownlint style guide.
Tools
LanguageTool
[uncategorized] ~101-~101: Possible missing comma found.
Context: ... start. If you need to ensure it stays constant pre-create the folder and create a `alg...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
98-98: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
100-100: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
| Example `algod.token`: | ||
| ```bash | ||
| c3818ac81a91c6e58df2b151a43caf7245e806ec02e4851bca01a1be2ba72da7 |
There was a problem hiding this comment.
Add blank lines around the fenced code block.
The example algod.token is a helpful addition to the documentation.
However, please add blank lines before and after the fenced code block to adhere to the Markdownlint style guide.
Tools
Markdownlint
104-104: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
| #### Conduit node | ||
|
|
||
| ```bash | ||
| docker run -e VOINETWORK_PROFILE=conduit -p 5011:8080 -v <my_local_path>:/algod/data ghcr.io/voinetwork/voi-node:latest | ||
| ``` | ||
|
|
||
| This maps local port 5011 to the blockchain service running on port 8080 within the container. | ||
| This mode is used if you want to connect an indexer and the conduit framework to the network, | ||
| in order to query network such, such as looking up transaction history. |
There was a problem hiding this comment.
Improve the sentence flagged by LanguageTool.
The new section explaining the purpose and command for running a conduit node is informative and adds value to the documentation.
However, consider rephrasing the following sentence to improve readability:
This mode is used if you want to connect an indexer and the conduit framework to the network, in order to query network such, such as looking up transaction history.
-This mode is used if you want to connect an indexer and the conduit framework to the network, in order to query network such, such as looking up transaction history.
+This mode is used to connect an indexer and the conduit framework to the network for querying transaction history and other network data.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.
| #### Conduit node | |
| ```bash | |
| docker run -e VOINETWORK_PROFILE=conduit -p 5011:8080 -v <my_local_path>:/algod/data ghcr.io/voinetwork/voi-node:latest | |
| ``` | |
| This maps local port 5011 to the blockchain service running on port 8080 within the container. | |
| This mode is used if you want to connect an indexer and the conduit framework to the network, | |
| in order to query network such, such as looking up transaction history. | |
| #### Conduit node | |
| ```bash | |
| docker run -e VOINETWORK_PROFILE=conduit -p 5011:8080 -v <my_local_path>:/algod/data ghcr.io/voinetwork/voi-node:latest | |
| ``` | |
| This maps local port 5011 to the blockchain service running on port 8080 within the container. | |
| This mode is used to connect an indexer and the conduit framework to the network for querying transaction history and other network data. |
Tools
LanguageTool
[style] ~92-~92: Consider a shorter alternative to avoid wordiness.
Context: ... the conduit framework to the network, in order to query network such, such as looking up ...(IN_ORDER_TO_PREMIUM)
Markdownlint
92-92: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
Summary by CodeRabbit
New Features
Documentation