Conversation
WalkthroughThe updates remove version-specific parameters from URLs in various documentation files for the Celestia project's RPC API, streamlining the links for consistency and ease of access. Additionally, setup blocks importing Changes
Poem
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: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- developers/blobstream-offchain.md (3 hunks)
- developers/golang-client-tutorial.md (5 hunks)
- developers/node-tutorial.md (3 hunks)
- developers/rust-client-tutorial.md (5 hunks)
Additional context used
LanguageTool
developers/golang-client-tutorial.md
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ... need the node URL and your auth token. To get your auth token, see this [guide](....
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...guide. To run your node without an auth token, yo...developers/rust-client-tutorial.md
[style] ~23-~23: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ... need the node URL and your auth token. To get your auth token, see this [guide](....
[style] ~23-~23: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...guide. To run your node without an auth token, yo...developers/blobstream-offchain.md
[style] ~17-~17: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. (EN_WEAK_ADJECTIVE)
Context: ... expect to copy and paste this code 🙂) a very simple Blobstream rollup to illustrate at a hi...
[style] ~108-~108: Consider using a more formal alternative. (MORE_INFO)
Context: ...lestia.org/). Additionally, if you need more information on how to run a light node, you can [ch...
[typographical] ~134-~134: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (HOWEVER_SENTENCE)
Context: ...ng for the head to be posted to Ethereum, however, it would likely be better to simply dow...
[uncategorized] ~161-~161: “to the” seems less likely than “the”. (AI_HYDRA_LEO_CP_TO_THE_THE)
Context: ...ing to data Typical blockchains commit to the transactions included in each block usi...
[uncategorized] ~168-~168: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ere the data is located in the Celestia block and the sequencer signs over that locat...developers/node-tutorial.md
[uncategorized] ~102-~102: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...all Golang celestia-node is written in Golang so we must install Golang to build and ...
[uncategorized] ~493-~493: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...se flags in the following order: 1. If user passes auth token, auth token is used. ...
[style] ~498-~498: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ore. #### Auth token 🔐 {#auth-token} In order to interact with the API using RPC CLI, yo...
[style] ~522-~522: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ....network arabica) ``` #### Node store In order to interact with the API using RPC CLI, yo...
[style] ~856-~856: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...# Get your node ID This is an RPC call in order to get your node's peerId information: ``...
[style] ~884-~884: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ur account address This is an RPC call in order to get your node's account address: ```ba...
[uncategorized] ~1028-~1028: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ...c02gxspa29wmh0d ``` Then, transfer the amount of tokens that you would like, while se...
[grammar] ~1060-~1060: The word ‘help’ is a conjunction. In formal texts, use “to”. (HELP_AND_VB)
Context: ...$NODE_STORE ``` #### Help To get help and view the CLI menu, use the following co...
[style] ~1087-~1087: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...rces ### Submitting a blob using curl In order to post a blob using curl, you will need a...
[uncategorized] ~1091-~1091: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ... consensus endpoint. The flag indicates node to connect to the given core consensus ...
[uncategorized] ~1154-~1154: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...net faucet has funded your account with tokens and then try again.
Markdownlint
developers/golang-client-tutorial.md
33-33: Column: 1 (MD010, no-hard-tabs)
Hard tabs
34-34: Column: 1 (MD010, no-hard-tabs)
Hard tabs
35-35: Column: 1 (MD010, no-hard-tabs)
Hard tabs
37-37: Column: 1 (MD010, no-hard-tabs)
Hard tabs
38-38: Column: 1 (MD010, no-hard-tabs)
Hard tabs
39-39: Column: 1 (MD010, no-hard-tabs)
Hard tabs
44-44: Column: 1 (MD010, no-hard-tabs)
Hard tabs
45-45: Column: 1 (MD010, no-hard-tabs)
Hard tabs
46-46: Column: 1 (MD010, no-hard-tabs)
Hard tabs
47-47: Column: 1 (MD010, no-hard-tabs)
Hard tabs
49-49: Column: 1 (MD010, no-hard-tabs)
Hard tabs
50-50: Column: 1 (MD010, no-hard-tabs)
Hard tabs
51-51: Column: 1 (MD010, no-hard-tabs)
Hard tabs
52-52: Column: 1 (MD010, no-hard-tabs)
Hard tabs
53-53: Column: 1 (MD010, no-hard-tabs)
Hard tabs
55-55: Column: 1 (MD010, no-hard-tabs)
Hard tabs
56-56: Column: 1 (MD010, no-hard-tabs)
Hard tabs
57-57: Column: 1 (MD010, no-hard-tabs)
Hard tabs
58-58: Column: 1 (MD010, no-hard-tabs)
Hard tabs
59-59: Column: 1 (MD010, no-hard-tabs)
Hard tabs
61-61: Column: 1 (MD010, no-hard-tabs)
Hard tabs
62-62: Column: 1 (MD010, no-hard-tabs)
Hard tabs
63-63: Column: 1 (MD010, no-hard-tabs)
Hard tabs
64-64: Column: 1 (MD010, no-hard-tabs)
Hard tabs
65-65: Column: 1 (MD010, no-hard-tabs)
Hard tabs
67-67: Column: 1 (MD010, no-hard-tabs)
Hard tabs
69-69: Column: 1 (MD010, no-hard-tabs)
Hard tabs
70-70: Column: 1 (MD010, no-hard-tabs)
Hard tabs
71-71: Column: 1 (MD010, no-hard-tabs)
Hard tabs
72-72: Column: 1 (MD010, no-hard-tabs)
Hard tabs
73-73: Column: 1 (MD010, no-hard-tabs)
Hard tabs
75-75: Column: 1 (MD010, no-hard-tabs)
Hard tabs
76-76: Column: 1 (MD010, no-hard-tabs)
Hard tabs
91-91: Column: 1 (MD010, no-hard-tabs)
Hard tabs
92-92: Column: 1 (MD010, no-hard-tabs)
Hard tabs
93-93: Column: 1 (MD010, no-hard-tabs)
Hard tabs
94-94: Column: 1 (MD010, no-hard-tabs)
Hard tabs
96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs
97-97: Column: 1 (MD010, no-hard-tabs)
Hard tabs
98-98: Column: 1 (MD010, no-hard-tabs)
Hard tabs
99-99: Column: 1 (MD010, no-hard-tabs)
Hard tabs
100-100: Column: 1 (MD010, no-hard-tabs)
Hard tabs
102-102: Column: 1 (MD010, no-hard-tabs)
Hard tabs
103-103: Column: 1 (MD010, no-hard-tabs)
Hard tabs
104-104: Column: 1 (MD010, no-hard-tabs)
Hard tabs
105-105: Column: 1 (MD010, no-hard-tabs)
Hard tabs
106-106: Column: 1 (MD010, no-hard-tabs)
Hard tabs
108-108: Column: 1 (MD010, no-hard-tabs)
Hard tabs
109-109: Column: 1 (MD010, no-hard-tabs)
Hard tabs
110-110: Column: 1 (MD010, no-hard-tabs)
Hard tabs
111-111: Column: 1 (MD010, no-hard-tabs)
Hard tabs
112-112: Column: 1 (MD010, no-hard-tabs)
Hard tabs
113-113: Column: 1 (MD010, no-hard-tabs)
Hard tabs
114-114: Column: 1 (MD010, no-hard-tabs)
Hard tabs
115-115: Column: 1 (MD010, no-hard-tabs)
Hard tabs
117-117: Column: 1 (MD010, no-hard-tabs)
Hard tabs
118-118: Column: 1 (MD010, no-hard-tabs)
Hard tabs
119-119: Column: 1 (MD010, no-hard-tabs)
Hard tabs
120-120: Column: 1 (MD010, no-hard-tabs)
Hard tabs
121-121: Column: 1 (MD010, no-hard-tabs)
Hard tabs
132-132: Column: 1 (MD010, no-hard-tabs)
Hard tabs
133-133: Column: 1 (MD010, no-hard-tabs)
Hard tabs
134-134: Column: 1 (MD010, no-hard-tabs)
Hard tabs
135-135: Column: 1 (MD010, no-hard-tabs)
Hard tabs
137-137: Column: 1 (MD010, no-hard-tabs)
Hard tabs
138-138: Column: 1 (MD010, no-hard-tabs)
Hard tabs
139-139: Column: 1 (MD010, no-hard-tabs)
Hard tabs
140-140: Column: 1 (MD010, no-hard-tabs)
Hard tabs
141-141: Column: 1 (MD010, no-hard-tabs)
Hard tabs
143-143: Column: 1 (MD010, no-hard-tabs)
Hard tabs
144-144: Column: 1 (MD010, no-hard-tabs)
Hard tabs
Additional comments not posted (16)
developers/golang-client-tutorial.md (5)
23-23: The updated URL forblob.Submitcorrectly removes the version-specific parameter, aligning with the PR's goal to standardize URLs.
29-29: The URL forblob.GetAllhas been correctly updated to remove the version-specific parameter, ensuring consistency across documentation links.
86-86: The URL forheader.Subscribehas been successfully updated. This change standardizes access to the latest documentation, which is beneficial for users.
127-127: The link forshare.GetEDShas been updated appropriately to exclude version-specific parameters, which simplifies the documentation and avoids potential confusion about versioning.
150-150: The general API documentation link has been updated to a non-version-specific URL. This change is crucial for ensuring users always access the most current documentation.developers/rust-client-tutorial.md (5)
29-29: The update to theblob.SubmitURL in the Rust client tutorial is correct, removing the version parameter to ensure users always have access to the latest documentation.
35-35: The URL forblob.GetAllhas been correctly updated, aligning with the objective to standardize documentation URLs and remove version-specific parameters.
75-75: The URL forheader.Subscribehas been updated appropriately. This change ensures that users accessing the Rust client documentation are directed to the most current content.
122-122: The link to theshare.GetEDSdocumentation has been successfully updated to remove version-specific parameters, facilitating easier access to the latest information.
145-145: The general API documentation link has been updated to a non-version-specific URL, which is essential for providing users with the most current and relevant information.developers/blobstream-offchain.md (2)
107-107: The updated link to the RPC documentation correctly removes the version-specific parameter, aligning with the overarching goal of the PR to standardize documentation URLs.
331-331: The link to the Celestia light node RPC for submitting data has been updated to exclude version-specific parameters. This change simplifies access to the latest documentation and is consistent with the changes in other tutorials.developers/node-tutorial.md (4)
427-427: Updated RPC API URL to a version-independent link.
446-446: Updated module links to version-independent URLs.Also applies to: 447-447, 448-448
451-451: Updated method links to version-independent URLs.Also applies to: 452-452, 453-453
581-581: Updated theblob.Submitlink to a version-independent URL.
2 participants
Overview
Fixes some links from #1617 because vitepress variables are silly
Summary by CodeRabbit