docs: fixes and improvement #1176
Conversation
WalkthroughThis update corrects grammatical errors and typos in several documentation files, including README.md, conventions.md, and archived docs. No changes were made to code, exported entities, or technical content; all modifications are limited to improving documentation clarity and accuracy. Changes
Possibly related PRs
Suggested labels
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README.md(1 hunks)archive/docs/HyphenFacet.md(1 hunks)archive/docs/MultichainFacet.md(1 hunks)conventions.md(1 hunks)
🔇 Additional comments (4)
archive/docs/HyphenFacet.md (1)
5-5: Approve grammar correction in "How it works"
The change from "if you using a native token" to "if you are using a native token" improves readability and correctness.README.md (1)
167-167: Approve grammar correction in "Contract Docs" section
Updating "more details documentation" to "more detailed documentation" enhances clarity without affecting links or content.conventions.md (1)
337-337: Approve grammar fix in "Structure of Deployment scripts"
Changing "Each deployment script follow this format:" to "Each deployment script follows this format:" corrects subject–verb agreement.archive/docs/MultichainFacet.md (1)
19-19: Approve removal of duplicatedfunctionkeyword
Correctly changing "function function registerRouters…" to "function registerRouters…" fixes a typographical error without altering the signature.
| - Calls `deploy()` using `type({ContractName}).creationCode`. | ||
| - **Structure of Update scripts:** | ||
| - Each deployment script follow this format: | ||
| - Each deployment script follows this format: |
There was a problem hiding this comment.
Fix section reference for update scripts
Under the "Structure of Update scripts" header, the bullet still reads "Each deployment script…". It should reference update scripts to avoid confusion.
Proposed diff:
- - Each deployment script follows this format:
+ - Each update script follows this format:📝 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.
| - Each deployment script follows this format: | |
| - Each update script follows this format: |
🤖 Prompt for AI Agents
In conventions.md at line 344, the bullet point incorrectly refers to "Each
deployment script" under the "Structure of Update scripts" header. Change the
wording to reference "Each update script" instead to accurately reflect the
section content and avoid confusion.
1 participant
Which Jira task belongs to this PR?
Why did I implement it this way?
Checklist before requesting a review
Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)