Improve Grammar and Clarity in Documentation #564
Conversation
WalkthroughThe pull request updates documentation in two files. In the contracts README, the installation instructions have been updated to reference Changes
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
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: 1
🧹 Nitpick comments (2)
contracts/README.md (1)
45-49: Consistency Check: Update Description vs. Command
The description now referencesfoundryfor dependency management, but the update command still usesforge soldeer update. Please verify if this discrepancy is intentional. If Foundry is the actual framework for dependency management, consider updating the command accordingly to avoid user confusion.doc/onboarding.md (1)
5-5: Grammatical Correction Acknowledged
The text now correctly usescannotinstead of “can not,” which improves grammatical accuracy. For even greater clarity, consider adding a comma after “correct” (e.g., “bothpublic keyandaddressare correct, as they are immutable and cannot be changed in the future”).🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...hat bothpublic keyandaddressare correct as they are immutable and cannot be cha...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
contracts/README.md(1 hunks)doc/onboarding.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
doc/onboarding.md
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...hat both public key and address are correct as they are immutable and cannot be cha...
(AI_HYDRA_LEO_MISSING_COMMA)
doc/onboarding.md
Outdated
| ## Step 4) Start the node | ||
|
|
||
| This step might differ for every operator. A good starting point is our [Deploy Doc](deploy.md) | ||
| This step might differ for every operator. A good starting point is our [Deploy Doc](deploy.md) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Update Deployment Documentation Terminology
The PR objective specifies updating the reference from “Deploy Doc” to “Deployment Guide” for a more professional tone. The current link text still reads “Deploy Doc”. Please update this reference to “Deployment Guide” to align with the documented objectives.
There was a problem hiding this comment.
@SITADRITA1 Thanks for the PR. coderrabitai's got a point.
Happy to merge this when it's fixed.
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
fbac
left a comment
fbac
left a comment
There was a problem hiding this comment.
Change Deploy Doc to Deloyment Guide.
Done ) |
2 participants
Consistency in Dependency Management Description
File: Documentation (e.g., README.md)
Before: "As the project uses soldeer, update the dependencies by running:"
After: "As the project uses foundry, update the dependencies by running:"
Reason: Foundry is the actual framework used. soldeer is a package manager within Foundry, so this phrasing better reflects the project's build process.
2. Correction of "can not" → "cannot"
File: Documentation (e.g., onboarding.md)
Before: "It is important that both public key and address are correct as they are immutable and can not be changed in the future."
After: "It is important that both public key and address are correct as they are immutable and cannot be changed in the future."
Reason: "Cannot" is the correct single-word form, whereas "can not" is rarely used in this context. This correction ensures proper grammar.
3. Improved Terminology in Deployment Guide Reference
File: Documentation (e.g., onboarding.md)
Before: "A good starting point is our Deploy Doc"
After: "A good starting point is our Deployment Guide"
Reason: "Deploy Doc" is an informal phrasing. "Deployment Guide" is more professional and standard for technical documentation.
Summary by CodeRabbit