docs: fix typos and grammar #4183
Conversation
…usion-proofs-and-pfb-fraud-proofs.md
Marcofann
requested review from
rootulp and
rach-id
and removed request for
a team
📝 WalkthroughWalkthroughThis pull request involves minor documentation updates across several Architecture Decision Records (ADRs) related to the Quantum Gravity Bridge (QGB) and Celestia's message handling. The changes primarily focus on improving clarity through terminology refinements, updating status information, and providing more detailed explanations of technical design considerations. The modifications span documents addressing validator set confirmations, data commitments, state usage reduction, and message padding rules. Changes
Possibly related PRs
Suggested labels
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 (2)
docs/architecture/adr-003-qgb-data-commitments.md (1)
15-15: Consider rephrasing for clarity and professionalism.The cross-reference to ADR-005 is valuable, but the phrasing could be more direct and professional.
Consider this revision:
-PS: The `ValsetConfirm` have been updated in `adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handling the confirmations. +Note: For details on handling confirmations, refer to the updated `ValsetConfirm` implementation in `adr-005-qgb-reduce-state-usage`.🧰 Tools
🪛 LanguageTool
[style] ~15-~15: To make your writing clearer, consider a more direct alternative.
Context: ...adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handl...(TAKE_A_LOOK)
docs/architecture/adr-002-qgb-valset.md (1)
15-15: Consider rephrasing for clarity and professionalism.For consistency with other ADR documents and improved clarity, the cross-reference could be rephrased.
Consider this revision:
-PS: The `ValsetConfirm` has been updated in `adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handling the confirmations. +Note: For details on handling confirmations, refer to the updated `ValsetConfirm` implementation in `adr-005-qgb-reduce-state-usage`.🧰 Tools
🪛 LanguageTool
[style] ~15-~15: To make your writing clearer, consider a more direct alternative.
Context: ...adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handl...(TAKE_A_LOOK)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/architecture/adr-002-qgb-valset.md(1 hunks)docs/architecture/adr-003-qgb-data-commitments.md(1 hunks)docs/architecture/adr-005-qgb-reduce-state-usage.md(1 hunks)docs/architecture/adr-009-non-interactive-default-rules-for-reduced-padding.md(1 hunks)docs/architecture/adr-011-optimistic-blob-size-independent-inclusion-proofs-and-pfb-fraud-proofs.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/architecture/adr-002-qgb-valset.md
[style] ~15-~15: To make your writing clearer, consider a more direct alternative.
Context: ...adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handl...
(TAKE_A_LOOK)
docs/architecture/adr-003-qgb-data-commitments.md
[style] ~15-~15: To make your writing clearer, consider a more direct alternative.
Context: ...adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handl...
(TAKE_A_LOOK)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (3)
docs/architecture/adr-005-qgb-reduce-state-usage.md (1)
39-39: LGTM! Clear and well-structured explanation.The sentence effectively explains the concept of gossiping confirmations and attestations in a separate P2P network.
docs/architecture/adr-011-optimistic-blob-size-independent-inclusion-proofs-and-pfb-fraud-proofs.md (1)
81-81: LGTM! Well-formatted mathematical explanation.The mathematical notation and explanation for calculating proof size are clear and consistent.
docs/architecture/adr-009-non-interactive-default-rules-for-reduced-padding.md (1)
67-67: LGTM! Clear mathematical explanation.The explanation about finding a message where the number of rows is log(n) of the message size is well-structured and mathematically sound.
rootulp
changed the title
Head branch was pushed to by a user without write access
Fixed the capitalization of "Linux" in the release notes to enhance readability and maintain consistency in documentation. This change aligns with previous efforts to improve the clarity of the project's documentation.
Corrected a minor typo in the Docker image publishing instructions to improve clarity. The word "create publish" was changed to "publish" for grammatical accuracy. This change enhances the readability of the documentation without affecting functionality.
| @@ -36,7 +36,7 @@ This way, we will always have a fixed-sized state, issue defining this: [Prune t | |||
|
|
|||
| ### Separate P2P network | |||
|
|
|||
| This would mean gossiping about the confirms and attestations in a separate P2P network. | |||
| This would mean gossiping about the confirmations and attestations in a separate P2P network. | |||
There was a problem hiding this comment.
You missed reverting this instance
| This would mean gossiping about the confirmations and attestations in a separate P2P network. | |
| This would mean gossiping about the confirms and attestations in a separate P2P network. |
Co-authored-by: Rootul P <[email protected]>
This pull request addresses several minor grammar and punctuation issues in multiple ADR (Architectural Decision Record) documents. The changes improve clarity, correctness, and consistency across the documentation. Below are the details of the updates:
Summary of Changes:
ADR-005-QGB-Reduce-State-Usage:
ADR-009-Non-Interactive-Default-Rules-for-Reduced-Padding:
ADR-011-Optimistic-Blob-Size-Independent-Inclusion-Proofs-and-PFB-Fraud-Proofs:
Rationale: