Skip to content

Commit

Permalink
fix: broken links in markdown documentation (#4240)
Browse files Browse the repository at this point in the history
<!--
This addition fixes 9 broken links in existing markdown documentation
-->

## Overview

- Fixes broken links in current markdown documentation
- Pairs the broken links with appropriate corresponding live (not
broken) page links
  • Loading branch information
mzkrasner authored Jan 19, 2025
1 parent 1b4447d commit 8f3a2e0
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/celestiaorg/celestia-app)](https://goreportcard.com/report/github.com/celestiaorg/celestia-app)
[![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/celestiaorg/celestia-app/badge)](https://www.gitpoap.io/gh/celestiaorg/celestia-app)

celestia-app is the software used by [validators](https://docs.celestia.org/nodes/validator-node) and [consensus nodes](https://docs.celestia.org/nodes/consensus-node) on the Celestia consensus network. celestia-app is a blockchain application built using parts of the Cosmos stack:
celestia-app is the software used by [validators](https://docs.celestia.org/how-to-guides/validator-node) and [consensus nodes](https://docs.celestia.org/how-to-guides/consensus-node) on the Celestia consensus network. celestia-app is a blockchain application built using parts of the Cosmos stack:

- [celestiaorg/cosmos-sdk](https://github.com/celestiaorg/cosmos-sdk) a fork of [cosmos/cosmos-sdk](https://github.com/cosmos/cosmos-sdk)
- [celestiaorg/celestia-core](https://github.com/celestiaorg/celestia-core) a fork of [cometbft/cometbft](https://github.com/cometbft/cometbft)
Expand Down Expand Up @@ -73,7 +73,7 @@ If you'd rather not install from source, you can download a prebuilt binary from
celestia-app_Linux_x86_64.tar.gz: OK
```
See <https://docs.celestia.org/nodes/celestia-app> for more information.
See <https://docs.celestia.org/how-to-guides/celestia-app> for more information.
## Usage
Expand Down
4 changes: 2 additions & 2 deletions docs/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ For more information refer to the module [docs](../../x/signal/README.md)

### Node Operators (v2.0.0)

If you are a consensus node operator, please follow the communication channels listed under [network upgrades](https://docs.celestia.org/nodes/participate#network-upgrades) to learn when this release is recommended for each network (e.g. Mocha, Mainnet Beta).
If you are a consensus node operator, please follow the communication channels listed under [network upgrades](https://docs.celestia.org/how-to-guides/participate#network-upgrades) to learn when this release is recommended for each network (e.g. Mocha, Mainnet Beta).

Consensus node operators are expected to upgrade to this release _prior_ to the Lemongrass hardfork if they intend to continue participating in the network. The command used to start the [consensus node](https://docs.celestia.org/nodes/consensus-node#start-the-consensus-node) or [validator node](https://docs.celestia.org/nodes/validator-node#run-the-validator-node) will accept an additional `--v2-upgrade-height` flag. See [this table](https://docs.celestia.org/nodes/network-upgrade-process#lemongrass-network-upgrade) for upgrade heights for each network.
Consensus node operators are expected to upgrade to this release _prior_ to the Lemongrass hardfork if they intend to continue participating in the network. The command used to start the [consensus node](https://docs.celestia.org/how-to-guides/consensus-node#start-the-consensus-node) or [validator node](https://docs.celestia.org/how-to-guides/validator-node#run-the-validator-node) will accept an additional `--v2-upgrade-height` flag. See [this table](https://docs.celestia.org/how-to-guides/network-upgrade-process#lemongrass-network-upgrade) for upgrade heights for each network.

Consensus node operators should enable the BBR (Bottleneck Bandwidth and Round-trip propagation time) congestion control algorithm. See [#3812](https://github.com/celestiaorg/celestia-app/pull/3812).

Expand Down
2 changes: 1 addition & 1 deletion tools/blocktime/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

`blocktime` is a simple tool to analyze block production rates of a chain. It scrapes the latest headers through the RPC endpoint of a provided node and calculates the average, min, max and standard deviation of the intervals between the last `n` blocks (default: 100).

To start a consensus node and expose the RPC endpoint, see the [docs](https://docs.celestia.org/nodes/consensus-node).
To start a consensus node and expose the RPC endpoint, see the [docs](https://docs.celestia.org/how-to-guides/consensus-node).

## Usage

Expand Down
2 changes: 1 addition & 1 deletion x/blob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ celestia-appd tx blob PayForBlobs <hex encoded namespace> <hex encoded data> [fl
```

For submitting PFB transaction via a light client's rpc, see [celestia-node's
documentation](https://docs.celestia.org/developers/node-tutorial#submitting-data).
documentation](https://docs.celestia.org/tutorials/node-tutorial#submitting-data).

The steps in the
[`SubmitPayForBlobs`](https://github.com/celestiaorg/celestia-app/blob/v1.0.0-rc2/x/blob/payforblob.go#L15-L54)
Expand Down

0 comments on commit 8f3a2e0

Please sign in to comment.