Skip to content

Commit 8a658d3

Browse files
authored
feat: Add link checker to Actions (#573)
* Add external link checker to Actions * remove blogpost rollkit/bitcoin * avoid fragment links
1 parent 5f05003 commit 8a658d3

23 files changed

+83
-126
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Link Checker
2+
3+
on:
4+
# This workflow requires pull_request and won't work with pull_request_target
5+
# due to github permissions
6+
pull_request:
7+
types:
8+
- opened
9+
- reopened
10+
- synchronize
11+
- closed
12+
# Uncomment the following lines to have the cronjob running daily
13+
#repository_dispatch:
14+
#workflow_dispatch:
15+
#schedule:
16+
#- cron: "00 18 * * *"
17+
18+
jobs:
19+
link-check:
20+
runs-on: ubuntu-latest
21+
permissions:
22+
issues: write # required for peter-evans/create-issue-from-file
23+
steps:
24+
- uses: actions/checkout@v4
25+
26+
- name: Link Checker
27+
id: lychee
28+
uses: lycheeverse/lychee-action@v2
29+
with:
30+
args: -b . --verbose --no-progress --exclude '%23.*' './**/*.md'
31+
fail: true
32+
33+
# Uncomment this if you want issues to be created for every dead link
34+
#- name: Create Issue From File
35+
#if: steps.lychee.outputs.exit_code != 0
36+
#uses: peter-evans/create-issue-from-file@v5
37+
#with:
38+
#title: Link Checker Report
39+
#content-filepath: ./lychee/out.md
40+
#labels: report, automated issue

.vitepress/config.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -354,10 +354,6 @@ function sidebarHome() {
354354
collapsed: true,
355355
items: [
356356
{ text: "Overview", link: "/blog/overview" },
357-
{
358-
text: "Sovereign rollups on Bitcoin with Rollkit",
359-
link: "/blog/sovereign-rollups-on-bitcoin",
360-
},
361357
{
362358
text: "Rollkit: The First Sovereign Rollup Framework",
363359
link: "/blog/rollkit-the-first-sovereign-rollup-framework",

blog/overview.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ Welcome to our blog! Here, you'll find a variety of articles on a range of topic
88

99
## Table of contents
1010

11-
- [Sovereign rollups on Bitcoin with Rollkit](/blog/sovereign-rollups-on-bitcoin)
1211
- [Rollkit: The First Sovereign Rollup Framework](/blog/rollkit-the-first-sovereign-rollup-framework.md)
1312

1413
Stay tuned for more exciting content!

blog/rollkit-the-first-sovereign-rollup-framework.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import Twitter from '../.vitepress/components/twitter.vue'
1919

2020
By Rollkit
2121

22-
![Rollkit blog cover](/img/Rollkit-cover.jpg)
22+
![Rollkit blog cover](/public/img/Rollkit-cover.jpg)
2323

2424
Bitcoin to Ethereum took 7 years. Ethereum to more scalable alt-L1s took 1–2 years. And then Cosmos SDK and CometBFT brought down time-to-launch a sovereign L1 to months.
2525

@@ -33,7 +33,7 @@ Sovereign rollups combine the self-governance of a Layer 1 with the ease of depl
3333

3434
Without the overhead of a settlement layer, sovereign rollups can directly interoperate with shared security when using the same DA layer.
3535

36-
By using a generic application interface like [ABCI++](https://docs.cometbft.com/v0.38/spec/abci/), Rollkit is compatible with the Cosmos SDK, the leading framework for building sovereign blockchains. This enables all Cosmos SDK developers to build a sovereign rollup and tap into all the powerful cosmos ecosystem tooling they’re used to including [IBC](https://www.ibcprotocol.dev/), [ABCI++](https://docs.cometbft.com/v0.38/spec/abci/), and Skip Protocol's [Slinky](https://docs.skip.money/slinky/overview/) and [BlockSDK](https://skip-protocol-docs.netlify.app/blocksdk/overview).
36+
By using a generic application interface like [ABCI++](https://docs.cometbft.com/v0.38/spec/abci/), Rollkit is compatible with the Cosmos SDK, the leading framework for building sovereign blockchains. This enables all Cosmos SDK developers to build a sovereign rollup and tap into all the powerful cosmos ecosystem tooling they’re used to including [IBC](https://www.ibcprotocol.dev/), [ABCI++](https://docs.cometbft.com/v0.38/spec/abci/), and Skip Protocol's [Slinky](https://docs.skip.money/slinky/overview/) and BlockSDK.
3737

3838
Developers have full-freedom to deploy a VM or define their own execution environment, unconstrained by the overhead of an enshrined settlement layer that must process fraud or ZK proofs for their rollups. This means that instead of a canonical on-chain light client that comes with an enshrined settlement layer, sovereign rollups can define how they interoperate with other blockchains by having on-chain light clients of each other as needed.
3939

blog/sovereign-rollups-on-bitcoin.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

guides/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,7 @@ instrumentation:
573573
**Description:**
574574
The network address (host:port) where the Prometheus metrics server will listen for scraping requests.
575575

576-
See [Metrics](./metrics.md) for more details on what metrics are exposed.
576+
See [Metrics](/guides/metrics.md) for more details on what metrics are exposed.
577577

578578
**YAML:**
579579

guides/create-genesis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide will walk you through the process of setting up a genesis for your ro
66

77
For this guide you need to have a chain directory where you have created and built your chain.
88

9-
If you don't have a chain directory yet, you can initialize a simple ignite chain by following [this guide](./ignite-rollkit.md)
9+
If you don't have a chain directory yet, you can initialize a simple ignite chain by following [this tutorial](/tutorials/gm-world.md)
1010

1111
:::tip
1212
This guide will use the simple ignite chain created in linked guide. Make sure to update any relevant variables to match your chain.
@@ -27,7 +27,7 @@ STAKING_AMOUNT="1000000000stake"
2727

2828
## 2. Rebuild your chain
2929

30-
Ensure that `rollkit.toml` is present in the root of your rollup directory (if not, follow a [Guide](/guides/use-rollkit-cli) to set it up) and run the following command to (re)generate an entrypoint binary out of the code:
30+
Ensure that `rollkit.toml` is present in the root of your rollup directory (if not, follow a [Guide](/tutorials/gm-world.md) to set it up) and run the following command to (re)generate an entrypoint binary out of the code:
3131

3232
```sh
3333
rollkit rebuild

guides/cw-orch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ Now that you workspace is setup, you can [integrate with single contracts](#sing
245245

246246
You can find more example interactions on the `counter-contract` example directly in the `cw-orchestrator` repo:
247247

248-
- Some examples <a href="https://github.com/AbstractSDK/cw-orchestrator/blob/main/contracts/counter/examples/deploy.rs" target="_blank">showcase interacting with live chains</a>.
249-
- Some other examples show <a href="https://github.com/AbstractSDK/cw-orchestrator/tree/main/contracts/counter/tests" target="_blank">how to use the library for testing your contracts</a>.
248+
- Some examples <a href="https://github.com/AbstractSDK/cw-orchestrator/blob/main/contracts-ws/contracts/counter/examples/deploy.rs" target="_blank">showcase interacting with live chains</a>.
249+
- Some other examples show <a href="https://github.com/AbstractSDK/cw-orchestrator/blob/main/contracts-ws/contracts/counter/tests/checksum.rs" target="_blank">how to use the library for testing your contracts</a>.
250250

251251
> **FINAL ADVICE**: Learn more and explore our <a href="https://orchestrator.abstract.money" target="blank" >full `cw-orch` documentation !</a>.

guides/ibc-connection.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# IBC connection tutorial
22

33
In this tutorial, we'll learn how to use [an Inter-Blockchain Communication (IBC) Protocol relayer](https://github.com/cosmos/relayer) to
4-
create an IBC connection between a [GM world](./gm-world) rollup and an Osmosis local testnet.
4+
create an IBC connection between a [GM world](/tutorials/gm-world.md) rollup and an Osmosis local testnet.
55

66
:::warning Disclaimer
77
This initial version of IBC has high trust assumptions where receiving chains
@@ -66,7 +66,7 @@ bash init-local.sh
6666
```
6767

6868
:::tip
69-
[See the guidelines in GM world rollup for environment setup](/tutorials/gm-world#building-your-sovereign-rollup).
69+
[See the guidelines in GM world rollup for environment setup](/tutorials/gm-world.md).
7070
:::
7171

7272
## Run your local-osmosis-testnet

guides/restart-rollup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This section covers the case where you need to restart your rollup.
99
In order to restart your rollup, you simply need to run the `<your-binary>d start [...args]`
1010
command for your rollup.
1111

12-
For example, if you ran the [quick start](../tutorials/quick-start.md) tutorial, you started your rollup with:
12+
For example, if you ran the [quick start](/tutorials/quick-start.md) tutorial, you started your rollup with:
1313

1414
```bash
1515
rollkit start
@@ -47,8 +47,8 @@ This section covers the case that the node that
4747
you are using to post blocks to your DA and consensus layer runs out of funds (tokens),
4848
and you need to restart your rollup.
4949

50-
In this example, we're using Celestia's [Mocha testnet](https://docs.celestia.org/nodes/mocha-testnet/)
51-
and running the [quick start](../tutorials/quick-start.md). In this example, our Celestia DA light node
50+
In this example, we're using Celestia's [Mocha testnet](https://docs.celestia.org/how-to-guides/mocha-testnet/)
51+
and running the [quick start](/tutorials/quick-start.md). In this example, our Celestia DA light node
5252
ran out of Mocha testnet TIA and we are unable to post new blocks to Celestia due to a
5353
[`Code: 19`](https://github.com/cosmos/cosmos-sdk/blob/main/types/errors/errors.go#L95)
5454
error. This error is defined by Cosmos SDK as:
@@ -88,7 +88,7 @@ You can stop your rollup by using `Control + C` in your terminal where the node
8888

8989
### ⛽ Increase the gas fee {#increase-gas-fee}
9090

91-
To reiterate, before restarting the chain, you will need to increase the gas fee in order to avoid a `Code: 19` error. See the [How to configure gas price](./gas-price.md) guide for more information.
91+
To reiterate, before restarting the chain, you will need to increase the gas fee in order to avoid a `Code: 19` error. See the [How to configure gas price](/guides/config.md#da-gas-price) guide for more information.
9292

9393
### 🔁 Restarting your rollup {#restarting-your-rollup}
9494

0 commit comments

Comments
 (0)