Fix: Update broken links in documentation #1821
Conversation
WalkthroughThe pull request includes extensive updates to several documentation files related to deploying and integrating Blobstream and Arbitrum technologies. Key changes involve clarifying deployment instructions, enhancing the prerequisites and configuration details, and improving the structure of guides. New sections have been added to address WebSocket connections and compatibility matrices, while existing sections have been reorganized for better clarity. Links have been updated to ensure accuracy, and additional context has been provided throughout to assist developers in understanding the integration processes. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration 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: 1
🧹 Outside diff range and nitpick comments (1)
how-to-guides/blobstream-offchain.md (1)
182-182: Consider linking to a specific version tagThe link to the shares documentation currently points to the
mainbranch. For better documentation stability, consider linking to a specific version tag.Replace:
-[shares](https://github.com/celestiaorg/celestia-app/blob/main/specs/src/shares.md) +[shares](https://github.com/celestiaorg/celestia-app/blob/v1.1.0/specs/src/shares.md)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (6)
how-to-guides/arbitrum-deploy.md(1 hunks)how-to-guides/blobstream-offchain.md(1 hunks)how-to-guides/blobstream.md(1 hunks)how-to-guides/celestia-node.md(1 hunks)how-to-guides/decide-node.md(1 hunks)how-to-guides/feegrant-for-blobs.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
how-to-guides/blobstream.md
119-119: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
🔇 Additional comments (4)
how-to-guides/decide-node.md (1)
26-26: Verify the consensus node documentation path
The link has been updated from full-consensus-node.md to consensus-node.md. Let's verify this change is consistent across the documentation.
✅ Verification successful
Link update is consistent with the codebase
The verification confirms:
- The new path
consensus-node.mdexists athow-to-guides/consensus-node.md - No references to the old
full-consensus-node.mdremain in the codebase - All other documentation files correctly reference the new
consensus-node.mdpath
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the consensus node documentation path and check for any remaining references to the old path
# Check if the new file exists
echo "Checking if consensus-node.md exists:"
fd "consensus-node.md$"
# Check for any remaining references to the old path
echo -e "\nChecking for any remaining references to full-consensus-node.md:"
rg "full-consensus-node\.md"
# Check for any broken internal links to consensus node documentation
echo -e "\nChecking for any other consensus node documentation references:"
rg -i "consensus.*node.*\.md"
Length of output: 1585
how-to-guides/celestia-node.md (1)
147-147: Verify the nodes overview documentation path
The link has been updated from overview.md to nodes-overview.md. Let's verify this change is consistent across the documentation.
✅ Verification successful
Link path update is correct and consistent
The verification confirms:
- The new file
nodes-overview.mdexists at the correct location inhow-to-guides/ - The link in
celestia-node.mdcorrectly points to this file using a relative path - All references to the nodes overview documentation consistently use the new filename
nodes-overview.md
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the nodes overview documentation path and check for any remaining references to the old path
# Check if the new file exists
echo "Checking if nodes-overview.md exists:"
fd "nodes-overview.md$"
# Check for any remaining references to the old path
echo -e "\nChecking for any remaining references to overview.md:"
rg "overview\.md"
# Check for any broken internal links to overview documentation
echo -e "\nChecking for any other overview documentation references:"
rg -i "nodes.*overview.*\.md"
Length of output: 960
how-to-guides/blobstream.md (1)
119-119: Link update looks good!
The link to SP1 Blobstream contract Golang bindings has been correctly updated from a TODO placeholder to the actual resource at https://github.com/succinctlabs/sp1-blobstream/blob/main/bindings/SP1Blobstream.go.
🧰 Tools
🪛 Markdownlint (0.35.0)
119-119: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
how-to-guides/arbitrum-deploy.md (1)
416-416: Version update is accurate and well-documented!
The compatibility matrix has been updated with clear version information and helpful context about the Blobstream X functionality integration into nitro-contracts v1.2.1.
| @@ -24,7 +24,7 @@ a DA node's (grantee) account. You will need one account that will | |||
| contain the funds, the granter, and another account that will be in the | |||
| DA node you run to post blobs, the grantee. You will see the DA node's account | |||
| once you initialize the node. Learn more about managing accounts with | |||
| `cel-key` in [create a wallet with celestia-node](./celestia-node-key#create-a-wallet-with-celestia-node). | |||
| `cel-key` in [create a wallet with celestia-node](../tutorials/celestia-node-key.md#create-a-wallet-with-celestia-node). | |||
There was a problem hiding this comment.
💡 Codebase verification
Link needs to be updated to match the correct section heading
The current link #create-a-wallet-with-celestia-node points to the main heading which exists, but it's inconsistent across documentation. The file multiaccounts.md uses the same incorrect anchor. Suggested fixes:
- Update the link in
feegrant-for-blobs.mdto use the proper section heading:#using-the-cel-key-utility - For consistency, also update the link in
multiaccounts.md
🔗 Analysis chain
Verify the wallet creation tutorial link and section anchor
The link has been updated to point to a specific section in the celestia-node-key tutorial. Let's verify this change is correct and consistent.
Let me generate another verification script to check the exact content and structure of the tutorial file to verify the section anchor.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the celestia-node-key tutorial path and section anchor
# Check if the tutorial file exists
echo "Checking if celestia-node-key.md exists:"
fd "celestia-node-key.md$"
# Check if the section exists in the file
echo -e "\nChecking for the wallet creation section in the tutorial:"
rg -A 5 "^#.*create.*wallet.*celestia-node" tutorials/celestia-node-key.md
# Check for any other references to wallet creation documentation
echo -e "\nChecking for any other wallet creation documentation references:"
rg -i "create.*wallet.*celestia.*node"
Length of output: 893
Script:
#!/bin/bash
# Check the content and headers of the tutorial file
echo "Checking the content structure of celestia-node-key.md:"
cat tutorials/celestia-node-key.md | grep "^#"
# Check if there are any broken links in the documentation
echo -e "\nChecking for any broken or inconsistent links to the tutorial:"
rg -l "celestia-node-key(.md)?#" --type md
Length of output: 910
|
@jcstein Hi! Could you please take a look at my pull request? Your feedback is very important for moving forward. Thank you so much! |
|
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2024 Celestia Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
This pull request addresses the issue of broken links in the documentation. I replaced non-functional links with verified working ones. Before making the replacements, I tested the old links to confirm they were broken. These changes enhance the accuracy and usability of the documentation.
Each link was reviewed and updated to point to the correct and functional resource.
Summary by CodeRabbit
Release Notes
These updates aim to provide users with comprehensive and accessible resources for effective deployment and integration.