diff --git a/.github/workflows/markdowd_link_checker.yml b/.github/workflows/markdowd_link_checker.yml new file mode 100644 index 000000000..352a3ec74 --- /dev/null +++ b/.github/workflows/markdowd_link_checker.yml @@ -0,0 +1,18 @@ +name: Check Markdown links + +on: + # This workflow requires pull_request and won't work with pull_request_target + # due to github permissions + pull_request: + types: + - opened + - reopened + - synchronize + - closed + +jobs: + markdown-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: tcort/github-action-markdown-link-check@v1 \ No newline at end of file diff --git a/guides/create-genesis.md b/guides/create-genesis.md index 9cf71a948..5e2496002 100644 --- a/guides/create-genesis.md +++ b/guides/create-genesis.md @@ -6,7 +6,7 @@ This guide will walk you through the process of setting up a genesis for your ro For this guide you need to have a chain directory where you have created and built your chain. -If you don't have a chain directory yet, you can initialize a simple ignite chain by following [this guide](./ignite-rollkit.md) +If you don't have a chain directory yet, you can initialize a simple ignite chain by following [this tutorial](/tutorials/gm-world.md) :::tip 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" ## 2. Rebuild your chain -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: +Ensure that `rollkit.toml` is present in the root of your rollup directory (if not, follow a [Guide](../gm-world.md) to set it up) and run the following command to (re)generate an entrypoint binary out of the code: ```sh rollkit rebuild diff --git a/guides/overview.md b/guides/overview.md index d44ff94fa..4ff118b71 100644 --- a/guides/overview.md +++ b/guides/overview.md @@ -14,22 +14,21 @@ your life easier when developing with Rollkit. In this section, you'll find: -* [Create genesis for your rollup](/guides/create-genesis) -* [Restart your rollup](/guides/restart-rollup) -* [Reset your chain's state](/guides/reset-state) -* [Turn your CometBFT app into a Rollkit app](/guides/cometbft-to-rollkit) -* [Use Ignite to create a Rollkit app](/guides/ignite-rollkit) +* [Create genesis for your rollup](./create-genesis.md) +* [Restart your rollup](./restart-rollup.md) +* [Reset your chain's state](./reset-state.md) +* [Turn your CometBFT app into a Rollkit app](./cometbft-to-rollkit.md) * EVM Rollups - * [EVM Based Sequencer Setup](/guides/evm-based) - * [EVM Single Sequencer Setup](/guides/evm-single-guide) + * [EVM Based Sequencer Setup](./evm-based.md) + * [EVM Single Sequencer Setup](./evm-single-guide.md) * Configuration - * [Config Settings](/guides/config) + * [Config Settings](./config.md) * Integrations - * [Test and deploy cosmwasm smart-contracts](/guides/cw-orch) - * [Add zkML to your EVM rollup](/guides/zkml) - * [Add an IBC connection to your rollup](/guides/ibc-connection) - * [Integrate Range with your rollup](/guides/rollkit-monitoring) - * [Use IBC token (TIA) as gas token in your rollup](/guides/use-tia-for-gas) + * [Test and deploy cosmwasm smart-contracts](./cw-orch.md) + * [Add zkML to your EVM rollup](./zkml.md) + * [Add an IBC connection to your rollup](./ibc-connection.md) + * [Integrate Range with your rollup](./rollkit-monitoring.md) + * [Use IBC token (TIA) as gas token in your rollup](./use-tia-for-gas.md) ## 💻 Support {#support} diff --git a/tutorials/sequencing/overview.md b/tutorials/sequencing/overview.md index 544e12bce..585724d5e 100644 --- a/tutorials/sequencing/overview.md +++ b/tutorials/sequencing/overview.md @@ -1,4 +1,3 @@ - # Sequencing Sequencing is the essential first step for handling your transactions. Think of it as an organizer that takes all incoming transactions, puts them in a clear order, and then groups them into batches. This process is vital for keeping everything consistent and making the rollup run. Rollkit uses a "Sequencing Interface" with key functions like submitting, retrieving, and verifying these transaction batches, ensuring smooth communication between the rollup and the sequencing mechanism, which often acts as a bridge to the underlying network. @@ -27,5 +26,5 @@ An implementation of the sequencing interface mainly acts as a middleware that c The sequencing implementations that are currently work in progress: -* [based-sequencer](based) -* [forced-inclusion-sequencer](forced-inclusion) +* [based-sequencer](based.md) +* [forced-inclusion-sequencer](forced-inclusion.md)