Refine network documentation #751
Conversation
by linking directly to relevant pages.
WalkthroughThe recent changes primarily focus on updating the 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}
There was a problem hiding this comment.
Actionable comments posted: 6
Outside diff range and nitpick comments (3)
README.md (1)
Line range hint
35-37: Add alternative text to images to improve accessibility.- <img src="/docs/discord.svg" width="64" /> + <img src="/docs/discord.svg" width="64" alt="Join us on Discord" /> - <img src="/docs/telegram.svg" width="64" /> + <img src="/docs/telegram.svg" width="64" alt="Join us on Telegram" />chains/nemeton-1/README.md (2)
10-11: Consider reducing the use of exclamation marks to maintain a professional tone in documentation.
Line range hint
62-915: Add alternative text to images to improve accessibility.- <img width="80px" src="https://s3.amazonaws.com/keybase_processed_uploads/25738b36b7972b94112bc8dc0df13b05_200_200.jpg"/> + <img alt="Nodes.Guru Logo" width="80px" src="https://s3.amazonaws.com/keybase_processed_uploads/25738b36b7972b94112bc8dc0df13b05_200_200.jpg"/>
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (9)
- README.md (1 hunks)
- chains/devnet-1/README.md (1 hunks)
- chains/devnet-1/README.md.gtpl (1 hunks)
- chains/drunemeton-1/README.md (1 hunks)
- chains/drunemeton-1/README.md.gtpl (1 hunks)
- chains/nemeton-1/README.md (1 hunks)
- chains/nemeton-1/README.md.gtpl (1 hunks)
- chains/nemeton/README.md (1 hunks)
- chains/nemeton/README.md.gtpl (1 hunks)
Files skipped from review due to trivial changes (3)
- chains/devnet-1/README.md.gtpl
- chains/nemeton-1/README.md.gtpl
- chains/nemeton/README.md.gtpl
Additional Context Used
LanguageTool (10)
README.md (2)
Near line 13: The preposition “of” seems more likely in this position.
Context: ...applicable. For a complete description about nodes and validators, check out the [Ax...
Near line 32: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1252 characters long)
And Join the community!
Context: ...ntation!<a href="https://...
chains/devnet-1/README.md (2)
Near line 10: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 820 characters long)
Context: ...18.892191Z-red?style=for-the-badge) > [!IMPORTANT] > This network was originally...
Near line 11: This phrase is redundant. Consider writing “created”.
Context: ...dge) > [!IMPORTANT] > This network was originally created under the formerOKP4brand. The mai...chains/drunemeton-1/README.md (2)
Near line 11: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1726 characters long)
Context: ...ght&color=%231E2A4E&cacheSeconds=6) > [!IMPORTANT] > This network was originally...
Near line 12: This phrase is redundant. Consider writing “created”.
Context: ...s=6) > [!IMPORTANT] > This network was originally created under the formerOKP4brand. ## Regi...chains/nemeton-1/README.md (2)
Near line 10: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2415 characters long)
Context: ...3A00%3A00Z-red?style=for-the-badge) > [!IMPORTANT] > This network was originally...
Near line 11: This phrase is redundant. Consider writing “created”.
Context: ...dge) > [!IMPORTANT] > This network was originally created under the formerOKP4brand. ## Regi...chains/nemeton/README.md (2)
Near line 12: This phrase is redundant. Consider writing “created”.
Context: ...dge) > [!IMPORTANT] > This network was originally created under the formerOKP4brand. ...
Near line 21: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 1738 characters long)
Context: ...lf. Everything will be managed by the CI! The gentx generation can be done as fo...
Markdownlint (139)
README.md (2)
35: null
Images should have alternate text (alt text)
37: null
Images should have alternate text (alt text)chains/drunemeton-1/README.md (28)
61: null
Images should have alternate text (alt text)
68: null
Images should have alternate text (alt text)
75: null
Images should have alternate text (alt text)
82: null
Images should have alternate text (alt text)
89: null
Images should have alternate text (alt text)
96: null
Images should have alternate text (alt text)
103: null
Images should have alternate text (alt text)
110: null
Images should have alternate text (alt text)
117: null
Images should have alternate text (alt text)
124: null
Images should have alternate text (alt text)
131: null
Images should have alternate text (alt text)
138: null
Images should have alternate text (alt text)
145: null
Images should have alternate text (alt text)
152: null
Images should have alternate text (alt text)
159: null
Images should have alternate text (alt text)
166: null
Images should have alternate text (alt text)
173: null
Images should have alternate text (alt text)
180: null
Images should have alternate text (alt text)
187: null
Images should have alternate text (alt text)
194: null
Images should have alternate text (alt text)
201: null
Images should have alternate text (alt text)
213: null
Images should have alternate text (alt text)
220: null
Images should have alternate text (alt text)
227: null
Images should have alternate text (alt text)
234: null
Images should have alternate text (alt text)
241: null
Images should have alternate text (alt text)
248: null
Images should have alternate text (alt text)
255: null
Images should have alternate text (alt text)chains/nemeton-1/README.md (100)
62: null
Images should have alternate text (alt text)
69: null
Images should have alternate text (alt text)
76: null
Images should have alternate text (alt text)
83: null
Images should have alternate text (alt text)
90: null
Images should have alternate text (alt text)
97: null
Images should have alternate text (alt text)
104: null
Images should have alternate text (alt text)
111: null
Images should have alternate text (alt text)
118: null
Images should have alternate text (alt text)
125: null
Images should have alternate text (alt text)
132: null
Images should have alternate text (alt text)
144: null
Images should have alternate text (alt text)
151: null
Images should have alternate text (alt text)
158: null
Images should have alternate text (alt text)
165: null
Images should have alternate text (alt text)
172: null
Images should have alternate text (alt text)
179: null
Images should have alternate text (alt text)
186: null
Images should have alternate text (alt text)
193: null
Images should have alternate text (alt text)
205: null
Images should have alternate text (alt text)
212: null
Images should have alternate text (alt text)
219: null
Images should have alternate text (alt text)
226: null
Images should have alternate text (alt text)
233: null
Images should have alternate text (alt text)
245: null
Images should have alternate text (alt text)
252: null
Images should have alternate text (alt text)
264: null
Images should have alternate text (alt text)
271: null
Images should have alternate text (alt text)
283: null
Images should have alternate text (alt text)
300: null
Images should have alternate text (alt text)
312: null
Images should have alternate text (alt text)
319: null
Images should have alternate text (alt text)
331: null
Images should have alternate text (alt text)
338: null
Images should have alternate text (alt text)
350: null
Images should have alternate text (alt text)
367: null
Images should have alternate text (alt text)
374: null
Images should have alternate text (alt text)
381: null
Images should have alternate text (alt text)
388: null
Images should have alternate text (alt text)
400: null
Images should have alternate text (alt text)
407: null
Images should have alternate text (alt text)
419: null
Images should have alternate text (alt text)
426: null
Images should have alternate text (alt text)
438: null
Images should have alternate text (alt text)
445: null
Images should have alternate text (alt text)
457: null
Images should have alternate text (alt text)
469: null
Images should have alternate text (alt text)
476: null
Images should have alternate text (alt text)
483: null
Images should have alternate text (alt text)
495: null
Images should have alternate text (alt text)
502: null
Images should have alternate text (alt text)
514: null
Images should have alternate text (alt text)
521: null
Images should have alternate text (alt text)
533: null
Images should have alternate text (alt text)
540: null
Images should have alternate text (alt text)
547: null
Images should have alternate text (alt text)
554: null
Images should have alternate text (alt text)
561: null
Images should have alternate text (alt text)
573: null
Images should have alternate text (alt text)
580: null
Images should have alternate text (alt text)
587: null
Images should have alternate text (alt text)
599: null
Images should have alternate text (alt text)
606: null
Images should have alternate text (alt text)
613: null
Images should have alternate text (alt text)
620: null
Images should have alternate text (alt text)
627: null
Images should have alternate text (alt text)
634: null
Images should have alternate text (alt text)
641: null
Images should have alternate text (alt text)
648: null
Images should have alternate text (alt text)
660: null
Images should have alternate text (alt text)
667: null
Images should have alternate text (alt text)
674: null
Images should have alternate text (alt text)
681: null
Images should have alternate text (alt text)
693: null
Images should have alternate text (alt text)
700: null
Images should have alternate text (alt text)
707: null
Images should have alternate text (alt text)
714: null
Images should have alternate text (alt text)
721: null
Images should have alternate text (alt text)
728: null
Images should have alternate text (alt text)
735: null
Images should have alternate text (alt text)
752: null
Images should have alternate text (alt text)
759: null
Images should have alternate text (alt text)
771: null
Images should have alternate text (alt text)
778: null
Images should have alternate text (alt text)
785: null
Images should have alternate text (alt text)
792: null
Images should have alternate text (alt text)
799: null
Images should have alternate text (alt text)
806: null
Images should have alternate text (alt text)
813: null
Images should have alternate text (alt text)
820: null
Images should have alternate text (alt text)
837: null
Images should have alternate text (alt text)
844: null
Images should have alternate text (alt text)
851: null
Images should have alternate text (alt text)
858: null
Images should have alternate text (alt text)
865: null
Images should have alternate text (alt text)
872: null
Images should have alternate text (alt text)
879: null
Images should have alternate text (alt text)
901: null
Images should have alternate text (alt text)
908: null
Images should have alternate text (alt text)
915: null
Images should have alternate text (alt text)chains/nemeton/README.md (9)
66: null
Images should have alternate text (alt text)
78: null
Images should have alternate text (alt text)
85: null
Images should have alternate text (alt text)
92: null
Images should have alternate text (alt text)
99: null
Images should have alternate text (alt text)
106: null
Images should have alternate text (alt text)
113: null
Images should have alternate text (alt text)
120: null
Images should have alternate text (alt text)
127: null
Images should have alternate text (alt text)
Additional comments not posted (4)
README.md (1)
17-22: The reorganized list of networks enhances clarity and accessibility.chains/drunemeton-1/README.md.gtpl (1)
9-9: The new badge for chain height is correctly implemented and provides useful dynamic information.chains/nemeton/README.md (1)
11-15: Update on the network's status and historical note are clear and informative.chains/drunemeton-1/README.md (1)
9-9: The implementation of the new badge for chain height is accurate and functional.
This PR improves the network documentation by simplifying network references in the
README.mdfile for maintainability, explicitly mentioning that the networks were created under the oldOKP4brand, and - as a bonus - adding a blockchain height badge for thedrunemeton-1network (using the JSON value extraction from the blockchain REST API via shields.io).