chore: resolves markdown linting issues in main branch #3198
Conversation
staheri14
requested review from
liamsi,
adlerjohn,
evan-forbes,
rootulp,
cmwaters and
ninabarbakadze
as code owners
WalkthroughWalkthroughThe recent updates encompass refining documentation and specifications to enhance clarity and accuracy. A reference section was eliminated due to obsolescence, while adjustments in Celestia's namespace documentation emphasize user responsibility for managing collisions. Additionally, a README file was revised to provide precise guidance on test instance communication. These changes aim to improve understanding, underscore the importance of handling namespace conflicts, and enhance user guidance through streamlined documentation. Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
|
||
| ## Test Instance Communication and Experiment Flow | ||
|
|
||
| https://github.com/celestiaorg/celestia-app/blob/d698845db9b28cbacef2e5bde57ef9dc443fc21a/test/testground/network/role.go#L18-L36 | ||
| [Context](https://github.com/celestiaorg/celestia-app/blob/d698845db9b28cbacef2e5bde57ef9dc443fc21a/test/testground/network/role.go#L18-L36) | ||
|
|
||
| ```mermaid | ||
| sequenceDiagram |
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [75-75]
The phrase "testground cluster must be setup" should be corrected for grammatical accuracy.
- testground cluster must be setup in a
+ testground cluster must be set up in a
|
|
||
| Applications MUST refrain from using the [reserved namespaces](#reserved-namespaces) for their blob data. | ||
|
|
||
| Celestia does not ensure the prevention of non-reserved namespace collisions. | ||
| Celestia does not ensure the prevention of non-reserved namespace collisions. | ||
| Consequently, two distinct applications might use the same namespace. | ||
| It is the responsibility of these applications to be cautious and manage the implications and consequences arising from such namespace collisions. | ||
| Among the potential consequences is the _Woods Attack_, as elaborated in this forum post: [Woods Attack on Celestia](https://forum.celestia.org/t/woods-attack-on-celestia/59). |
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [10-10]
Consider rephrasing "In order to enable efficient retrieval of blobs by namespace" to a more concise form to avoid wordiness. For example:
- In order to enable efficient retrieval of blobs by namespace
+ To efficiently retrieve blobs by namespace📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [16-16]
The abbreviation "ID" is mentioned as "id" in the document. For consistency and clarity, consider using the all-uppercase form "ID" throughout the document.
- [version](#version) and [id](#id)
+ [version](#version) and [ID](#ID)📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [70-70]
Consider adding a comma for clarity in the sentence describing the placement of padding shares:
- ...placed at the end of the Celestia data square even if a new user-specifiable version is introduced.
+ ...placed at the end of the Celestia data square, even if a new user-specifiable version is introduced.
I am also wondering why, Do you think it is because of the version of the linter (the markdown linter)? I don't see any harm in bumping the version. |
Maybe closes #2212 ## Motivation #3198 (comment)
Maybe closes celestiaorg#2212 ## Motivation celestiaorg#3198 (comment)
This PR addresses several Markdown linting issues found in the main branch.