Docs clichain guide test #925
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request includes significant enhancements and restructuring of documentation related to creating and managing Keychains, as well as running a local chain. Key changes involve clearer instructions, the addition of tip boxes for important information, and a better-organized presentation of command examples. The updates aim to improve usability and readability across four main documents pertaining to Keychain operations and local chain management. Changes
Possibly related PRs
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: 1
🧹 Outside diff range and nitpick comments (13)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (4)
21-25: Clear instructions and helpful context provided.The simplified instructions and clear statement of assumptions are excellent. They help users understand the prerequisites for the following steps.
However, there's a minor grammatical issue to address:
In line 25, change "It's referenced as" to "It's referred to as" for better clarity:
-2. The next steps require your local account name, or key name. It's referenced as `my-key-name` in the provided command-line examples. +2. The next steps require your local account name, or key name. It's referred to as `my-key-name` in the provided command-line examples.
47-55: Helpful instructions for checking chain ID.The added instructions for checking the chain ID are clear and useful. The tip box for users who used a
justscript or devnet snapshot is a great addition.For consistency, consider formatting the command example as a code block:
- wardend status + ```bash + wardend status + ```🧰 Tools
🪛 LanguageTool
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...de, the chain ID iswarden_1337-1. ::: ## 2. Register a Keychain The follo...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
47-47: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
63-82: Improved command structure and added valuable information.The simplified command for creating a new Keychain and the separate listing of optional parameters greatly improve the readability of this section. The added information about Keychain fees is a valuable addition.
For better readability, consider adjusting the indentation of the fees section:
- `keychain-fees`: Keychain fees in aWARD (0.000000000000000001 WARD) - - `key_req`: A fee for creating a key pair - - `sig_req`: A fee for signing a transaction + - `key_req`: A fee for creating a key pair + - `sig_req`: A fee for signing a transaction
155-190: Excellent addition of instructions for adding the Writer account.The new instructions for adding the Writer account to the Keychain, along with the command example for checking the result and the example output, are very helpful additions. They provide a clear and complete guide for users to follow.
For consistency, consider applying these minor formatting improvements:
- Add the
bashidentifier to the code blocks:- ``` + ```bash wardend tx warden add-keychain-writer --from my-key-name \ --keychain-id 1 --writer $(wardend keys show -a my-keychain-writer-name) \ --chain-id chain_123-1 ``` - ``` + ```bash wardend query warden keychains ``` - ``` + ```bash keychains: - admins: - warden1h7akmejqcrafp3mfpjqamghh89kzmkgjzsy3mc ... ```
- Adjust the indentation in the example output for better readability:
keychains: - admins: - warden1h7akmejqcrafp3mfpjqamghh89kzmkgjzsy3mc creator: warden1h7akmejqcrafp3mfpjqamghh89kzmkgjzsy3mc description: my-keychain-description fees: key_req: - - amount: "100" - denom: award - sig_req: - - amount: "1" - denom: award + - amount: "100" + denom: award + sig_req: + - amount: "1" + denom: award id: "1" name: my-keychain-name writers: - warden18my6wqsrf5ek85znp8x202wwyg8rw4fqhy54k2 pagination: total: "1"These changes will improve the overall consistency and readability of the document.
🧰 Tools
🪛 Markdownlint
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
165-165: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
171-171: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (5)
9-18: LGTM! Consider adding a brief explanation of CLIChain.The overview changes and the new tip box improve clarity and provide valuable context. Well done!
As a minor suggestion, consider adding a brief explanation of what CLIChain is in the first paragraph, as it's introduced without context.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Ward](https://help.wardenprotocol.org). ::: ## Prerequisites Before you start, ...(UNLIKELY_OPENING_PUNCTUATION)
38-70: LGTM! Comprehensive variable explanations added.The expanded "Export variables" section is excellent. It now includes predefined settings for different setup methods and provides clear explanations for each variable.
Consider adding a note about the importance of setting these variables correctly, as they are crucial for the subsequent steps.
Line range hint
73-131: LGTM! Key request fulfillment process is now clearer.The restructured "Fulfill a key request" section provides clearer instructions and includes valuable new steps for checking request status. Great improvement!
Some minor suggestions:
- Consider using consistent formatting for all code blocks. Some use
bash while others usewithout a language specifier.- In step 3, consider adding a note to remind users to replace
1with their actual request ID, as it might not always be 1.🧰 Tools
🪛 LanguageTool
[grammar] ~89-~89: The usual collocation for “returned” is “to”, not “in”.
Context: ...N_IDYour request ID will be returned in the `id` field of the output:js...(RETURN_IN_THE)
🪛 Markdownlint
77-77: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
134-205: LGTM! Signature request fulfillment process is now more comprehensive.The revised "Fulfill a signature request" section provides more detailed instructions and includes a helpful tip for generating test data. The added steps for checking request status are valuable.
Some minor suggestions:
- Consider using consistent formatting for all code blocks. Some use
bash while others usewithout a language specifier.- In step 3, consider adding a note to remind users to replace the example values with their actual request ID and data.
- Consider adding a brief explanation of why Base64 encoding is used for the hash.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
🪛 Markdownlint
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
1-205: Consider addressing static analysis suggestions.
- Grammar:
- Consider rephrasing instances of "returned in" to "returned to" or "shown in" for better clarity. For example, "Your request ID will be shown in the
idfield of the output:"- Markdown formatting:
- Add language specifiers to all fenced code blocks. For example, change
tobash for shell commands or ```json for JSON output.- Punctuation:
- Remove loose punctuation marks, particularly after closing code blocks and before new sections.
These changes will improve the document's consistency and adhere to Markdown best practices.
🧰 Tools
🪛 LanguageTool
[grammar] ~126-~126: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
🪛 Markdownlint
122-122: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
128-128: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/developer-docs/docs/operate-a-node/run-a-local-chain.md (4)
Line range hint
25-41: Consider adding a note about version compatibilityThe prerequisites are well-defined. However, to future-proof the documentation, consider adding a note about version compatibility. For example:
"Note: The versions mentioned are the minimum required at the time of writing. Later versions should be compatible, but if you encounter issues, please refer to these specific versions."
This addition would help users understand whether they need to stick to exact versions or can use newer ones.
Line range hint
72-124: Consider adding the-Oflag to the wget commandThe instructions for Option 2 are clear and comprehensive. To improve the wget command, consider adding the
-Oflag to specify the output filename:wget -O devnet.tar.gz https://github.com/warden-protocol/snapshots/raw/main/devnet.tar.gzThis ensures that the downloaded file is always named
devnet.tar.gz, regardless of how it's named on the server.
Line range hint
126-278: Fix formatting in the "Create a Keychain" subsectionThe instructions for Option 3 are comprehensive and well-explained. However, there's a minor formatting issue in the "Create a Keychain" subsection. The link to the guide is not properly formatted as a Markdown link. Please update it as follows:
To create a Keychain and add a Keychain Writer, take steps from this guide: [Create a Keychain](/build-a-keychain/operate-a-keychain/create-a-keychain).This will ensure the link is clickable in the rendered documentation.
Line range hint
359-364: Consider making the node stopping information more prominentThe tips at the end of the document provide valuable additional information. However, the information about stopping the node and its implications (restarting from block 0) is crucial and might be easily missed in its current position.
Consider moving this information to a separate "Stopping the Node" section just before the final tips. This would make it more prominent and ensure users don't miss this important detail.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (3)
- docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (2 hunks)
- docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (3 hunks)
- docs/developer-docs/docs/operate-a-node/run-a-local-chain.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/developer-docs/docs/operate-a-node/run-a-local-chain.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...chain first to test your configuration. ::: :::tip You can skip this guide and t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...g requests](fulfill-requests-from-cli). ::: ## 1. Run a node 1. Run a local cha...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...the local account name isshulgin. ::: 3. In some of the commands, you'll a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...de, the chain ID iswarden_1337-1. ::: ## 2. Register a Keychain The follo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~152-~152: Did you mean “its” (the possessive pronoun)?
Context: ...` to get the Keychain Wrtier address by it's name. Alternatively, you can just speci...(ITS_PREMIUM)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...dress obtained in the previous step. ::: 4. Finally, add the Writer account t...(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Ward](https://help.wardenprotocol.org). ::: ## Prerequisites Before you start, ...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~89-~89: The usual collocation for “returned” is “to”, not “in”.
Context: ...N_IDYour request ID will be returned in the `id` field of the output:js...(RETURN_IN_THE)
[grammar] ~126-~126: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
🪛 Markdownlint
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
47-47: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
165-165: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
171-171: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md
77-77: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
122-122: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
128-128: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🔇 Additional comments (8)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (3)
11-13: Great addition of contextual information!The tip box effectively clarifies the difference between testing with a local chain and joining the Buenavista network. This addition helps users understand the purpose of the guide and sets the right expectations.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...chain first to test your configuration. ::: :::tip You can skip this guide and t...(UNLIKELY_OPENING_PUNCTUATION)
15-17: Excellent addition of alternative testing option!This tip box provides a valuable shortcut for users who want to quickly test a preconfigured Keychain. The links to the relevant sections make it easy for users to follow this alternative path.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...g requests](fulfill-requests-from-cli). ::: ## 1. Run a node 1. Run a local cha...(UNLIKELY_OPENING_PUNCTUATION)
29-41: Improved command examples and helpful tip.The reformatted command examples are much clearer and easier to follow. The added tip box provides valuable information for users who are using a
justscript or devnet snapshot, which enhances the overall usability of the guide.🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...the local account name isshulgin. ::: 3. In some of the commands, you'll a...(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (2)
24-26: LGTM! Prerequisites are now clearer.The updated prerequisites provide more specific instructions and clarify when certain steps can be skipped. This improvement helps users understand the setup process better.
Line range hint
1-205: Great improvements to the documentation!Overall, the changes to this document significantly enhance its clarity, completeness, and usability. The added details, explanations, and tips provide comprehensive guidance for developers working with key and signature requests.
Key improvements:
- Clearer overview and prerequisites
- Detailed explanation of environment variables
- More comprehensive instructions for fulfilling key and signature requests
- Addition of status checking steps
To further polish the document:
- Ensure consistent formatting across all code blocks
- Address the minor grammar and punctuation issues mentioned earlier
- Consider adding brief explanations for technical terms or concepts that might be unfamiliar to some users
Great work on improving this documentation!
🧰 Tools
🪛 LanguageTool
[grammar] ~126-~126: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
🪛 Markdownlint
122-122: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
128-128: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/developer-docs/docs/operate-a-node/run-a-local-chain.md (3)
Line range hint
1-23: LGTM: Clear and concise overviewThe overview section effectively introduces the three options for running a node, providing a clear structure for the rest of the document.
Line range hint
43-70: LGTM: Clear instructions for running thejustscriptThe instructions for Option 1 are clear, concise, and easy to follow. The inclusion of the note about checking the genesis file settings is helpful for users who might need to verify or customize their setup.
Line range hint
280-357: LGTM: Informative Result sectionThe Result section effectively explains what users should expect when the chain is running and provides a helpful example of how to query the chain status. This information is crucial for users to verify that their setup is working correctly.
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
Show resolved
Hide resolved
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (2)
19-55: Clear instructions for running a node with helpful examples.The "Run a node" section provides clear, step-by-step instructions with well-formatted command examples. The added tip boxes offer valuable context for different setup scenarios.
However, there's a minor formatting improvement to be made:
Please add a language specifier to the code block on line 47 for consistency:
- ``` + ```bash wardend status ```🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...the local account name isshulgin. ::: 3. In some of the commands, you'll a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...de, the chain ID iswarden_1337-1. ::: ## 2. Register a Keychain The follo...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
47-47: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
116-190: Detailed instructions for adding a Keychain Writer with clear examples.This section provides comprehensive steps for adding a Keychain Writer, including well-formatted command examples and helpful explanations. The tip box clarifying the use of the Writer's address is a valuable addition.
However, there are a few minor formatting improvements to be made:
Please add language specifiers to the following code blocks for consistency:
- Line 157:
- ``` + ```bash wardend tx warden add-keychain-writer --from my-key-name \ --keychain-id 1 --writer $(wardend keys show -a my-keychain-writer-name) \ --chain-id chain_123-1 ```
- Line 165:
- ``` + ```bash wardend query warden keychains ```
- Line 171:
- ``` + ```yaml keychains: - admins: - warden1h7akmejqcrafp3mfpjqamghh89kzmkgjzsy3mc ... ```🧰 Tools
🪛 LanguageTool
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...dress obtained in the previous step. ::: 4. Finally, add the Writer account t...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
165-165: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
171-171: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...chain first to test your configuration. ::: :::tip You can skip this guide and t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...g requests](fulfill-requests-from-cli). ::: ## 1. Run a node 1. Run a local cha...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...the local account name isshulgin. ::: 3. In some of the commands, you'll a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...de, the chain ID iswarden_1337-1. ::: ## 2. Register a Keychain The follo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...dress obtained in the previous step. ::: 4. Finally, add the Writer account t...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
47-47: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
165-165: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
171-171: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🔇 Additional comments (3)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (3)
11-17: Well-structured introduction with helpful tips.The added tip boxes effectively highlight important information about testing with a local chain and provide an alternative approach for users. This enhances the document's usability and helps guide users through the process more effectively.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...chain first to test your configuration. ::: :::tip You can skip this guide and t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...g requests](fulfill-requests-from-cli). ::: ## 1. Run a node 1. Run a local cha...(UNLIKELY_OPENING_PUNCTUATION)
Line range hint
57-114: Comprehensive guide for registering a Keychain.This section provides clear instructions for creating a new Keychain, including a well-formatted command example and detailed explanations of both required and optional parameters. The addition of the command to check the created Keychain, along with an example output, is particularly helpful for users to verify their actions.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...chain first to test your configuration. ::: :::tip You can skip this guide and t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...g requests](fulfill-requests-from-cli). ::: ## 1. Run a node 1. Run a local cha...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...the local account name isshulgin. ::: 3. In some of the commands, you'll a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...de, the chain ID iswarden_1337-1. ::: ## 2. Register a Keychain The follo...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
47-47: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
192-197: Concise and helpful "Next steps" section.The "Next steps" section effectively guides users to relevant documentation based on their goals after creating a Keychain. The provided links are appropriate and cover different scenarios, enhancing the overall usability of the guide.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...dress obtained in the previous step. ::: 4. Finally, add the Writer account t...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
165-165: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
171-171: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (5)
9-18: Great improvements to the overview section!The changes in the overview provide better context and clarity for the reader. The addition of the tip box is particularly helpful in guiding users to alternative methods and related documentation.
Consider adding a brief sentence explaining what CLIChain is, as it's introduced here for the first time. For example:
"CLIChain is a command-line tool for managing keys and signatures in the Warden Protocol ecosystem."🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Ward](https://help.wardenprotocol.org). ::: ## Prerequisites Before you start, ...(UNLIKELY_OPENING_PUNCTUATION)
38-70: Excellent updates to the "Export variables" sectionThe addition of predefined settings for users who used a
justscript or a devnet snapshot is very helpful. The detailed descriptions of each variable greatly improve understanding.Consider adding a note about the importance of these environment variables for the subsequent steps. For example:
"Note: These environment variables are crucial for the commands in the following sections. Ensure they are correctly set before proceeding."
Line range hint
73-131: Great improvements to the "Fulfill a key request" sectionThe restructured steps and clarified instructions make the process easier to follow. The addition of status checking steps is particularly valuable for users to confirm successful operations.
Regarding the static analysis hints:
- In lines 89 and 126, consider rephrasing to address the grammar suggestion:
"Your request ID will be returned as theidfield in the output:"
"Your request status will be returned as thestatusfield in the output:"- In line 77, add a language specifier to the code block:
- Similarly, add
bashas the language specifier to the code blocks in lines 122 and 128.These minor changes will improve the document's consistency and address the static analysis suggestions.
🧰 Tools
🪛 LanguageTool
[grammar] ~89-~89: The usual collocation for “returned” is “to”, not “in”.
Context: ...N_IDYour request ID will be returned in the `id` field of the output:js...(RETURN_IN_THE)
🪛 Markdownlint
77-77: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
134-205: Excellent updates to the "Fulfill a signature request" sectionThe revised and expanded steps provide more detailed and helpful instructions. The addition of the tip for generating a Base64-encoded hash is particularly useful for testing purposes.
To address the remaining static analysis hints:
- In line 168, consider rephrasing:
"Your request ID and data for signing will be returned as theidanddata_for_signingfields in the output:"- In line 201, rephrase similarly:
"Your request status will be returned as thestatusfield in the output:"- Add
bashas the language specifier to the code blocks in lines 138, 147, 155, 197, and 203.These changes will improve consistency and address the static analysis suggestions.
Additionally, consider adding a note at the end of this section to remind users of the importance of securely managing private keys, especially in a production environment.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
🪛 Markdownlint
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
1-205: Overall excellent improvements to the documentThis revision significantly enhances the clarity, structure, and completeness of the guide for fulfilling key and signature requests from the CLI. The additions of tips, more detailed explanations, and status checking steps provide valuable guidance for users.
To further improve the document:
- Consider adding a brief introduction to CLIChain in the overview section.
- Add a note about the importance of the environment variables before the command sections.
- Implement the suggested grammar improvements and add language specifiers to code blocks as mentioned in previous comments.
- Include a reminder about secure key management practices, especially for production environments.
These minor enhancements will make an already great document even more user-friendly and comprehensive.
🧰 Tools
🪛 LanguageTool
[grammar] ~126-~126: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
🪛 Markdownlint
122-122: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
128-128: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Ward](https://help.wardenprotocol.org). ::: ## Prerequisites Before you start, ...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~89-~89: The usual collocation for “returned” is “to”, not “in”.
Context: ...N_IDYour request ID will be returned in the `id` field of the output:js...(RETURN_IN_THE)
[grammar] ~126-~126: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
🪛 Markdownlint
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md
77-77: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
122-122: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
128-128: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🔇 Additional comments (1)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (1)
24-26: Improved prerequisites sectionThe updates to the prerequisites section provide clearer and more specific instructions. The conditional instructions based on the method used to run the node are particularly helpful for users with different setups.
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (11)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (2)
37-39: Enhanced clarity in prerequisites section.The updated wording and the addition of the tip box provide clearer instructions and helpful information about the local account name. This improvement will assist users in correctly identifying their key name.
Consider adding a brief explanation of what the
justscript is or providing a link to more information about it for users who might not be familiar with it.🧰 Tools
🪛 LanguageTool
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ... keys by runningwardend keys list. ::: ## 1. Create an EVM project 1. Crea...(UNLIKELY_OPENING_PUNCTUATION)
Line range hint
115-115: Corrected typographical error in migration script instructions.The typographical error in the file creation instruction has been corrected from "with the following s:" to "with the following contents:". This change improves the accuracy of the instructions.
However, there's still a minor formatting issue. The colon at the end of the line should be removed to maintain consistency with the formatting in other sections.
Consider removing the colon at the end of the line to match the formatting in other sections:
-In `/warden-smart-contract/migrations`, create a new file `2_deploy_hello_warden.js` with the following contents: +In `/warden-smart-contract/migrations`, create a new file `2_deploy_hello_warden.js` with the following contents🧰 Tools
🪛 LanguageTool
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ... keys by runningwardend keys list. ::: ## 1. Create an EVM project 1. Crea...(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (2)
19-55: Great improvements to the "Run a node" section!The restructuring and expansion of this section significantly enhance its clarity and usefulness. The added commands for checking available keys and account balances, along with the tip about the default local account name, provide valuable guidance for users. The instructions for checking the chain ID are also a helpful addition.
One minor suggestion:
Consider adding a language specifier to the code block on line 47 for consistency with other code blocks in the document. For example:
- ``` + ```bash wardend status ```🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...the local account name isshulgin. ::: 3. In some of the commands, you'll a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...de, the chain ID iswarden_1337-1. ::: ## 2. Register a Keychain The follo...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
47-47: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
63-82: Improved clarity in the "Register a Keychain" sectionThe simplification of the initial command and the separate listing of optional parameters greatly enhance the readability and usability of this section. Users can now easily understand the basic usage while still having access to advanced options.
However, I noticed that the note about aWARD value has been removed.
Consider adding a brief explanation about aWARD, perhaps as a tip box, to ensure users understand the token denomination. For example:
:::tip aWARD is the smallest unit of WARD token. 1 WARD = 1,000,000,000,000,000,000 aWARD (10^18 aWARD). :::This information helps users better understand the fee amounts they're setting.
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (5)
9-18: Great improvements to the overview section!The updated introduction is more concise and clearer. The addition of the tip box provides valuable context for users, offering alternative approaches and linking to relevant resources.
Consider adding a brief sentence explaining what a Keychain is, for users who might be new to the concept. This could help set the context for the entire document.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Ward](https://help.wardenprotocol.org). ::: ## Prerequisites Before you start, ...(UNLIKELY_OPENING_PUNCTUATION)
38-70: Excellent additions to the "Export variables" sectionThe new subsection for users who used the
justscript is a great addition, making the guide more inclusive. The detailed explanations for each variable are very helpful for understanding their purpose and origin.Consider adding a note about the importance of replacing the example values with actual values when not using the
justscript. This could help prevent copy-paste errors.
Line range hint
73-131: Great improvements to the "Fulfill a key request" sectionThe restructured steps and clarified instructions significantly improve the user experience. The addition of steps to check the request status is particularly helpful for users to confirm their actions. The consistent output format enhances readability.
In step 3, consider adding a note to remind users to replace
1with their actual request ID, even though it's mentioned in the command. This could help prevent errors for less attentive users.🧰 Tools
🪛 LanguageTool
[grammar] ~89-~89: The usual collocation for “returned” is “to”, not “in”.
Context: ...N_IDYour request ID will be returned in the `id` field of the output:js...(RETURN_IN_THE)
🪛 Markdownlint
77-77: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
134-205: Excellent enhancements to the "Fulfill a signature request" sectionThe expanded instructions and more detailed steps greatly improve the user experience. The addition of the tip box for creating a Base64-encoded hash is particularly helpful for testing purposes. The consistent output format enhances readability throughout the section.
In the tip box (lines 144-160), consider adding a brief explanation of why a Base64-encoded hash is used. This could help users understand the purpose behind this step in the process.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
🪛 Markdownlint
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
77-77: Enhance code block formattingTo improve readability and enable proper syntax highlighting, consider adding language specifiers to all code blocks. Currently, some blocks are missing these specifiers.
Add language specifiers to the following code blocks:
- Line 77: Add ```bash
- Line 122: Add ```bash
- Line 128: Add ```json
- Line 138: Add ```bash
- Line 147: Add ```bash
- Line 155: Add ```bash
- Line 197: Add ```bash
- Line 203: Add ```json
This will ensure consistency across all code blocks and improve the overall document structure.
Also applies to: 122-122, 128-128, 138-138, 147-147, 155-155, 197-197, 203-203
🧰 Tools
🪛 Markdownlint
77-77: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/developer-docs/docs/operate-a-node/run-a-local-chain.md (2)
Line range hint
63-208: Option 2 provides comprehensive instructions, with room for minor improvements.The manual configuration instructions are detailed and easy to follow. However, consider the following suggestions to enhance clarity:
Add a brief explanation of the
sedcommand's purpose in step 2 of "Create and configure a chain". For example:# This command replaces all occurrences of 'stake' with 'award' in the genesis file sed -i 's/stake/award/g' ../.warden/config/genesis.jsonIn step 8 of "Create and configure a chain", clarify the purpose of setting
minimum-gas-prices:# Set the minimum gas price to 0 for testing purposes # This determines the lowest transaction fee the node will accept wardend config set app minimum-gas-prices 0awardAdd a security note regarding zero gas prices:
:::warning Setting gas prices to zero is suitable for testing but should never be used in a production environment as it can lead to spam attacks and network congestion. :::These additions will provide users with a better understanding of the commands they're executing and the implications of certain settings.
273-273: Minor: Remove extra punctuation at the end of the tip.There's an extra punctuation mark at the end of the final tip. Please remove it for consistency.
Apply this change:
-If you need to stop the node, use **Ctrl + C**. To start it again from block 0, run `wardend start`.::: +If you need to stop the node, use **Ctrl + C**. To start it again from block 0, run `wardend start`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~273-~273: Loose punctuation mark.
Context: ...gain from block 0, runwardend start. :::(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (5)
- docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (2 hunks)
- docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (3 hunks)
- docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (1 hunks)
- docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1 hunks)
- docs/developer-docs/docs/operate-a-node/run-a-local-chain.md (5 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md
🧰 Additional context used
📓 Path-based instructions (4)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/developer-docs/docs/operate-a-node/run-a-local-chain.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...chain first to test your configuration. ::: :::tip You can skip this guide and t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...g requests](fulfill-requests-from-cli). ::: ## 1. Run a node 1. Run a local cha...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...the local account name isshulgin. ::: 3. In some of the commands, you'll a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...de, the chain ID iswarden_1337-1. ::: ## 2. Register a Keychain The follo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...dress obtained in the previous step. ::: 4. Finally, add the Writer account t...(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Ward](https://help.wardenprotocol.org). ::: ## Prerequisites Before you start, ...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~89-~89: The usual collocation for “returned” is “to”, not “in”.
Context: ...N_IDYour request ID will be returned in the `id` field of the output:js...(RETURN_IN_THE)
[grammar] ~126-~126: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
docs/developer-docs/docs/operate-a-node/run-a-local-chain.md
[uncategorized] ~273-~273: Loose punctuation mark.
Context: ...gain from block 0, runwardend start. :::(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
47-47: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
165-165: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
171-171: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md
77-77: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
122-122: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
128-128: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🔇 Additional comments (12)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (2)
Line range hint
9-11: Improved clarity in the overview section.The updated introduction provides a clearer context for the guide, explicitly mentioning the "Hello World" Solidity smart contract and emphasizing its testing purpose on a local chain. This change helps set proper expectations for the reader.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ... keys by runningwardend keys list. ::: ## 1. Create an EVM project 1. Crea...(UNLIKELY_OPENING_PUNCTUATION)
Line range hint
1-224: Overall improvement in documentation quality.The changes made to this file have significantly enhanced its clarity, accuracy, and user-friendliness. The introduction now sets clearer expectations, the prerequisites section provides more helpful information, and the instructions have been refined for better understanding.
These improvements will make it easier for developers to follow the guide and successfully deploy an EVM contract on the Warden chain.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ... keys by runningwardend keys list. ::: ## 1. Create an EVM project 1. Crea...(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (3)
11-17: Excellent addition of context-setting tip boxes!The newly added tip boxes at the beginning of the document provide valuable context and guidance for users. They clearly explain the purpose of using a local chain for testing and offer an alternative for users who want to test a preconfigured Keychain. This addition enhances the overall user experience and helps set appropriate expectations.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...chain first to test your configuration. ::: :::tip You can skip this guide and t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...g requests](fulfill-requests-from-cli). ::: ## 1. Run a node 1. Run a local cha...(UNLIKELY_OPENING_PUNCTUATION)
Line range hint
192-196: Well-structured "Next steps" sectionThis section effectively guides users to appropriate next steps based on their goals. The clear categorization and links to relevant documentation make it easy for users to continue their journey, whether they want to become an actual Keychain operator, start fulfilling requests, or build a Keychain app. This addition enhances the overall user experience and provides a smooth transition to related topics.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...dress obtained in the previous step. ::: 4. Finally, add the Writer account t...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
165-165: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
171-171: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
1-196: Overall excellent improvements to the Keychain creation guideThis document has undergone significant enhancements that greatly improve its usability, clarity, and comprehensiveness. The restructured content, added tip boxes, and expanded instructions provide a much clearer step-by-step approach to creating and managing a Keychain.
Key improvements include:
- Better context-setting with informative tip boxes
- Clearer instructions for running a node and checking account information
- Simplified command examples with separate listings for optional parameters
- Expanded and restructured section on adding a Keychain Writer
- Clear guidance for next steps
These changes will significantly enhance the user experience for developers working with Keychains. The minor suggestions provided in the review comments (such as adding a language specifier to a code block and including a note about aWARD) will further refine this already greatly improved document.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...dress obtained in the previous step. ::: 4. Finally, add the Writer account t...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
157-157: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
165-165: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
171-171: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/fulfill-requests-from-cli.md (2)
24-26: Improved clarity in prerequisitesThe updates to the prerequisites section provide more specific instructions and account for different user setups. The note about skipping a step when using the
justscript is particularly helpful in preventing unnecessary actions.
Line range hint
1-205: Minor grammar and punctuation observationsOverall, the document is well-written and clear. There are a few minor points to note:
- There are instances of loose punctuation marks (e.g., lines 17 and 160), but these are likely due to Markdown formatting and can be ignored.
- The document uses "returned in" instead of "returned to" when referring to output fields. This usage is acceptable in this technical context and doesn't need to be changed.
The document maintains good grammar and punctuation throughout, contributing to its clarity and readability.
🧰 Tools
🪛 LanguageTool
[grammar] ~126-~126: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...$CHAIN_ID | wardend q wait-tx ``` ::: 2. Get all signature requests: `...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~168-~168: The usual collocation for “returned” is “to”, not “in”.
Context: ...request ID and data for signing will be returned in theidanddata_for_signingfields ...(RETURN_IN_THE)
[grammar] ~201-~201: The usual collocation for “returned” is “to”, not “in”.
Context: ... ``` Your request status will be returned in thestatusfield of the output: ...(RETURN_IN_THE)
🪛 Markdownlint
122-122: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
128-128: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
138-138: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
147-147: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
155-155: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
197-197: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
203-203: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/developer-docs/docs/operate-a-node/run-a-local-chain.md (5)
Line range hint
1-17: LGTM: Overview section is clear and concise.The updated overview provides a clear and concise introduction to running a local chain. The reduction from three to two options simplifies the document structure and improves readability.
Line range hint
19-34: LGTM: Prerequisites are well-defined.The prerequisites section clearly outlines the necessary tools and their versions. The added tip for installing
justusing brew is a helpful addition for users.
Line range hint
36-61: LGTM: Option 1 provides clear instructions.The simplified instructions for running a local chain using the
justscript are clear and easy to follow. The added note about checking node settings in the genesis file is a valuable addition for users who need more detailed information.
210-213: LGTM: Additional settings section is informative.The instructions for creating a Space are clear and include verification steps. The reference to an external guide for Keychain creation is appropriate and helps maintain document conciseness.
Line range hint
216-273: LGTM: Result section provides clear expectations and examples.The expanded Result section offers valuable information for users to verify their local chain's operation. The inclusion of the
wardend statuscommand example and its output is particularly helpful for users to understand what to expect when the chain is running correctly.🧰 Tools
🪛 LanguageTool
[uncategorized] ~273-~273: Loose punctuation mark.
Context: ...gain from block 0, runwardend start. :::(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
Show resolved
Hide resolved
Summary by CodeRabbit
create-a-keychain.mddocument for creating and managing Keychains.fulfill-requests-from-cli.mdfor fulfilling key and signature requests via CLIChain, including new tips and clearer command formats.run-a-local-chain.mdwith clearer guidance on running a local chain, including streamlined methods, detailed prerequisites, and expanded instructions for manual configuration.deploy-a-wasm-contract.md, including specific local account naming.deploy-an-evm-contract.mdto enhance clarity and consistency in deploying EVM contracts, focusing on a simple "Hello World" example.