Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Update broken links in documentation #1821

Merged
merged 6 commits into from
Dec 13, 2024
Merged

Fix: Update broken links in documentation #1821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3cb28ca
broken link arbitrum-deploy.md
youyyytrok Dec 6, 2024
7c7cdf8
broken link blobstream-offchain.md
youyyytrok Dec 6, 2024
073b7d9
add link blobstream.md
youyyytrok Dec 6, 2024
abf827b
broken link celestia-node.md
youyyytrok Dec 6, 2024
3e3eec0
fix broken link decide-node.md
youyyytrok Dec 6, 2024
753834a
broken link feegrant-for-blobs.md
youyyytrok Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion how-to-guides/arbitrum-deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ Extra resources in Arbitrum documentation:
| Component | Version | Details |
|-----------|---------|---------|
| Nitro | [v2.3.1-rc.1](https://github.com/celestiaorg/nitro/releases/tag/v2.3.1-rc.1) | Includes the replay binary for the WASM root `0x10c65b27d5031ce2351c719072e58f3153228887f027f9f6d65300d2b5b30152`. [Read the overview for overall changes](../how-to-guides/arbitrum-integration.md). |
| Contracts | [v1.2.1-celestia](https://github.com/celestiaorg/nitro-contracts/releases/tag/v1.2.1-celestia) | Integrates Blobstream X functionality into nitro-contracts v1.2.1 |
| Contracts | [v1.2.1](https://github.com/celestiaorg/nitro-contracts/releases/tag/v1.2.1) | Integrates Blobstream X functionality into nitro-contracts v1.2.1 |
| Orbit SDK | [v0.8.2 Orbit SDK for Celestia DA](https://github.com/celestiaorg/arbitrum-orbit-sdk/releases/tag/v0.8.2) | This is not compatible with Orbit SDK v0.8.2 or with the latest changes to nitro-contracts for the Atlas upgrade. The Orbit SDK itself is in Alpha. |
| celestia-node | [v0.13.1](https://github.com/celestiaorg/celestia-node/releases/tag/v0.13.1) | This integration has only been tested with celestia-node 0.13.1 and only works with said version, and with future versions after that. Under the hood, the Nitro node uses [this commit](https://github.com/celestiaorg/celestia-openrpc/commit/64f04840aa97d4deb821b654b1fb59167d242bd1) of celestia-openrpc. |
<!-- markdownlint-enable MD013 -->
Expand Down
2 changes: 1 addition & 1 deletion how-to-guides/blobstream-offchain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ proof used to verify state. Find more information in the
Also, see the documentation for the
[data square layout](https://github.com/celestiaorg/celestia-app/blob/v1.1.0/specs/src/specs/data_square_layout.md)
and the
[shares](https://github.com/celestiaorg/celestia-app/blob/main/specs/src/specs/shares.md)
[shares](https://github.com/celestiaorg/celestia-app/blob/main/specs/src/shares.md)
of the Celestia block to see how the data is encoded in Celestia.

### Creating blocks
Expand Down
2 changes: 1 addition & 1 deletion how-to-guides/blobstream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ along with code for:

- [The SP1 Blobstream smart contract - `SP1Blobstream.sol`](https://github.com/succinctlabs/sp1-blobstream/blob/main/contracts/src/SP1Blobstream.sol)
- [The SP1 program](https://github.com/succinctlabs/sp1-blobstream/tree/main/program)
- [The SP1 Blobstream contract Golang bindings](//TODO)
- [The SP1 Blobstream contract Golang bindings](https://github.com/succinctlabs/sp1-blobstream/blob/main/bindings/SP1Blobstream.go)

The first deployments of SP1 Blobstream will be maintained on the
following chains: Arbitrum One, Base and Ethereum Mainnet. Every 1
Expand Down
2 changes: 1 addition & 1 deletion how-to-guides/celestia-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ View [the script](https://github.com/celestiaorg/docs/tree/main/public/celestia-

## Next steps

First, we recommend [reading the overview](./overview.md)
First, we recommend [reading the overview](./nodes-overview.md)
of our node types, if you haven't yet.

Now that you've installed Celestia Node, it's time to
Expand Down
2 changes: 1 addition & 1 deletion how-to-guides/decide-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ or a [full DA node](./full-storage-node.md).
## Consensus node

If you are looking to run a consensus node, please follow the
[tutorial for running a consensus node](./full-consensus-node.md).
[tutorial for running a consensus node](./consensus-node.md).

Note that running a validator means you must also run a bridge node,
which is covered in [this section](./bridge-node.md).
2 changes: 1 addition & 1 deletion how-to-guides/feegrant-for-blobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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.md to 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


## Granting fee allowances using celestia-node

Expand Down
Loading