docs: fix typos in network upgrades and Docker documentation #4195
Conversation
Corrected minor grammatical errors in the ADR 018 document and the Docker documentation. Changes include adding commas for clarity and correcting the capitalization of "GitHub." These updates enhance the readability and consistency of the documentation.
tiendn
requested review from
cmwaters and
evan-forbes
and removed request for
a team
📝 WalkthroughWalkthroughThe pull request involves minor documentation updates across three files. In 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: 0
🧹 Nitpick comments (1)
docs/architecture/adr-018-network-upgrades.md (1)
42-42: Add semicolon or period for better clarityThe sentence contains two independent clauses that should be properly separated. Consider adding a semicolon or splitting into two sentences:
-The design depends on a versioned state machine whereby the app version displayed in each block and agreed upon by all validators is the version that the transactions are both validated and executed against. If the celestia state machine is given a block at version 1, it will execute it with the v1 state machine if consensus provides a v2 block, all the transactions will be executed against the v2 state machine. +The design depends on a versioned state machine whereby the app version displayed in each block and agreed upon by all validators is the version that the transactions are both validated and executed against. If the celestia state machine is given a block at version 1, it will execute it with the v1 state machine; if consensus provides a v2 block, all the transactions will be executed against the v2 state machine.🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: A punctuation mark might be missing here.
Context: ...ill execute it with the v1 state machine if consensus provides a v2 block, all the ...(AI_EN_LECTOR_MISSING_PUNCTUATION)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/architecture/adr-018-network-upgrades.md(1 hunks)docs/maintainers/docker.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/maintainers/docker.md
🧰 Additional context used
🪛 LanguageTool
docs/architecture/adr-018-network-upgrades.md
[uncategorized] ~42-~42: A punctuation mark might be missing here.
Context: ...ill execute it with the v1 state machine if consensus provides a v2 block, all the ...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: docker-security-build / docker-build (GHCR; ghcr.io/celestiaorg/celestia-app)
- GitHub Check: docker-txsim-build / docker-build (GHCR; ghcr.io/celestiaorg/txsim)
- GitHub Check: test / test-short
- GitHub Check: test / test-race
- GitHub Check: test / test-fuzz
- GitHub Check: test / test-coverage
- GitHub Check: test / test
- GitHub Check: markdown-linter / markdown-link-check
- GitHub Check: Summary
🔇 Additional comments (1)
docs/architecture/adr-018-network-upgrades.md (1)
44-44: LGTM!The comma before "which" in this sentence is correctly placed, improving readability.
|
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
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/architecture/adr-018-network-upgrades.md (3)
42-42: Add semicolon for better sentence structureThe compound sentence needs better separation between independent clauses.
-The design depends on a versioned state machine whereby the app version displayed in each block and agreed upon by all validators is the version that the transactions are both validated and executed against. If the celestia state machine is given a block at version 1, it will execute it with the v1 state machine if consensus provides a v2 block, all the transactions will be executed against the v2 state machine. +The design depends on a versioned state machine whereby the app version displayed in each block and agreed upon by all validators is the version that the transactions are both validated and executed against. If the celestia state machine is given a block at version 1, it will execute it with the v1 state machine; if consensus provides a v2 block, all the transactions will be executed against the v2 state machine.🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: A punctuation mark might be missing here.
Context: ...ill execute it with the v1 state machine if consensus provides a v2 block, all the ...(AI_EN_LECTOR_MISSING_PUNCTUATION)
44-44: Add comma after introductory phraseAdd a comma after the introductory phrase for better readability.
-Given this a node can at any time spin up a v2 binary, which will immediately be able to continue validating and executing v1 blocks as if it were a v1 machine. +Given this, a node can at any time spin up a v2 binary, which will immediately be able to continue validating and executing v1 blocks as if it were a v1 machine.
59-59: Improve sentence structure and subject-verb agreementMultiple grammatical improvements needed in this paragraph:
- Add comma after "in fact"
- Remove incorrect comma before "that"
- Fix subject-verb agreement with "quorum"
-There is no indication that a quorum has in fact upgraded and that when the proposer proposes a block with the message to change version, that consensus will be reached. +There is no indication that a quorum has, in fact, upgraded and that when the proposer proposes a block with the message to change version that consensus will be reached.-the `MsgVersionChange` that the quorum have agreed to. +the `MsgVersionChange` that the quorum has agreed to.🧰 Tools
🪛 LanguageTool
[typographical] ~59-~59: Consider isolating this adverbial phrase with commas.
Context: ...There is no indication that a quorum has in fact upgraded and that when the proposer pro...(IN_FACT_COMMA_2)
[typographical] ~59-~59: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...block with the message to change version, that consensus will be reached. To mitigate ...(COMMA_THAT_NOUN)
[uncategorized] ~59-~59: A comma might be missing here.
Context: ...here is no verification. Upon a certain threshold which must be at least 2/3+ but could p...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~59-~59: This verb does not appear to agree with the subject. Consider using a different form.
Context: ... theMsgVersionChangethat the quorum have agreed to. The rest works as before. F...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/architecture/adr-018-network-upgrades.md(2 hunks)docs/release-notes/release-notes.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/release-notes/release-notes.md
🧰 Additional context used
🪛 LanguageTool
docs/architecture/adr-018-network-upgrades.md
[uncategorized] ~42-~42: A punctuation mark might be missing here.
Context: ...ill execute it with the v1 state machine if consensus provides a v2 block, all the ...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[typographical] ~59-~59: Consider isolating this adverbial phrase with commas.
Context: ...There is no indication that a quorum has in fact upgraded and that when the proposer pro...
(IN_FACT_COMMA_2)
[typographical] ~59-~59: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...block with the message to change version, that consensus will be reached. To mitigate ...
(COMMA_THAT_NOUN)
[uncategorized] ~59-~59: A comma might be missing here.
Context: ...here is no verification. Upon a certain threshold which must be at least 2/3+ but could p...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~59-~59: This verb does not appear to agree with the subject. Consider using a different form.
Context: ... the MsgVersionChange that the quorum have agreed to. The rest works as before. F...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
Corrected minor grammatical errors in the ADR 018 document and the Docker documentation.
Changes includes:
These updates enhance the readability and consistency of the documentation.