fix: merge tutorials into guides #589
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughAll documentation references to "Tutorials" were renamed to "How To Guides," including navigation, sidebar groups, and internal links throughout the site. Paths were updated from Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant NavBar
participant Sidebar
participant DocsPages
User->>NavBar: Clicks "How To Guides"
NavBar->>DocsPages: Loads /guides/quick-start
User->>Sidebar: Browses "How To Guides" section
Sidebar->>DocsPages: Loads selected /guides/... page
Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @pthmas, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request streamlines the documentation structure by consolidating the previously separate 'tutorials' and 'guides' sections into a single, more intuitive 'how-to guides' category. This change improves clarity and navigability for users seeking instructional content by removing redundant categories and updating all related paths and links.
Highlights
- Documentation Structure Consolidation: The 'tutorials' documentation section has been merged into the 'guides' section to simplify the overall content structure and improve clarity.
- Navigation and Sidebar Updates: The main navigation bar and the sidebar configuration in
.vitepress/config.tshave been updated to remove the 'Tutorials' entry and reflect the new 'How To Guides' consolidated section. - Extensive Link and Path Refactoring: All internal links and file paths pointing to the former
/tutorials/directory have been updated to now point to the new/guides/directory, ensuring all documentation references remain valid across the site.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
There was a problem hiding this comment.
Code Review
This pull request merges the tutorials content into the guides section, simplifying the documentation structure. The changes are comprehensive, covering configuration files, README, and various markdown documents. All links and references have been updated accordingly. Ensuring consistency in link formatting across all markdown files by removing the .md extension aligns with VitePress best practices.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (15)
guides/execution/cosmwasm.md (1)
31-31: Consider omitting the.mdextension from internal links.While the path update from
/tutorials/to/guides/is correct, VitePress best practices recommend omitting the.mdextension from internal links for consistency.guides/sequencing/overview.md (1)
29-30: Omit “.md” in internal links for VitePress consistencyPrior reviews already flagged this pattern. VitePress resolves extensions automatically, so drop “.md” for cleaner URLs.
-* [based-sequencer](/guides/sequencing/based.md) -* [forced-inclusion-sequencer](/guides/sequencing/forced-inclusion.md) +* [based-sequencer](/guides/sequencing/based) +* [forced-inclusion-sequencer](/guides/sequencing/forced-inclusion)blog/rollkit-the-first-sovereign-rollup-framework.md (1)
73-74: Drop “.md” from the relative linkSame feedback as earlier: internal docs links should be extension-less.
-[Get started](/guides/quick-start.md) with launching your own sovereign chain with Rollkit. +[Get started](/guides/quick-start) with launching your own sovereign chain with Rollkit.guides/da/celestia-da.md (1)
12-13: Remove file extension in/guides/linksFor consistency with VitePress routing, strip the “.md”.
-Before proceeding, ensure that you have completed the [gm-world](/guides/gm-world.md) tutorial, +Before proceeding, ensure that you have completed the [gm-world](/guides/gm-world) tutorial,-`gmd` CLI installed from the [gm-world](/guides/gm-world.md) tutorial. +`gmd` CLI installed from the [gm-world](/guides/gm-world) tutorial.Also applies to: 49-50
guides/gm-world.md (1)
10-11: Consistent internal linking—remove “.md”Follow the project-wide convention.
-... Unlike the [quick start guide](/guides/quick-start.md), this tutorial ... +... Unlike the [quick start guide](/guides/quick-start), this tutorial ...guides/docker-compose.md (1)
3-4: Strip “.md” from internal guide referencesKeeps links short and aligns with earlier feedback.
-This tutorial is going to show you how to deploy the [gm-world chain](/guides/gm-world.md) using Docker Compose. +This tutorial is going to show you how to deploy the [gm-world chain](/guides/gm-world) using Docker Compose.-Make sure you have your gm-world chain ready by completing [the Build your chain tutorial](/guides/gm-world.md). +Make sure you have your gm-world chain ready by completing [the Build your chain tutorial](/guides/gm-world).-... commands you used in the [gm-world tutorial](/guides/gm-world.md). +... commands you used in the [gm-world tutorial](/guides/gm-world).Also applies to: 20-21, 219-220
guides/restart-rollup.md (2)
12-12: Drop.mdsuffix & update wording to “guide”.For VitePress, omit the
.mdextension and keep terminology consistent with the new “How-To Guides” section.-For example, if you ran the [quick start](/guides/quick-start.md) tutorial, you started your rollup with: +For example, if you ran the [quick start](/guides/quick-start) guide, you started your rollup with:
51-52: Same link/wording issue here.-and running the [quick start](/guides/quick-start.md). In this example, our Celestia DA light node +and running the [quick start](/guides/quick-start) guide. In this example, our Celestia DA light nodeguides/use-tia-for-gas.md (1)
9-9: Omit.mdextension in internal link.-Unlike the [quick start guide](/guides/quick-start.md), which uses a native rollup token for gas, +Unlike the [quick start guide](/guides/quick-start), which uses a native rollup token for gas,guides/da/overview.md (2)
61-62: Consistent link style & wording.-You might have noticed that we did not define any DA layer during the [quick start](/guides/quick-start.md) or [build a chain](/guides/gm-world.md) tutorials. +You might have noticed that we did not define any DA layer during the [quick start](/guides/quick-start) or [build a chain](/guides/gm-world) guides.
75-76: Remove.mdextensions in bullet links.-* [Local DA](/guides/da/local-da.md) -* [Celestia DA](/guides/da/celestia-da.md) +* [Local DA](/guides/da/local-da) +* [Celestia DA](/guides/da/celestia-da)guides/reset-state.md (2)
17-18: Link & wording alignment.-In order to complete this guide, you will need to have completed either the [quick start tutorial](/guides/quick-start.md) or the [build our chain tutorial](/guides/gm-world.md). +In order to complete this guide, you will need to have completed either the [quick start guide](/guides/quick-start) or the [build-our-chain guide](/guides/gm-world).
55-56: Same fix for gm-world reference.-When you ran your gm-world chain in the [build your chain tutorial](/guides/gm-world.md), it created a `.gm` directory in your `$HOME` directory. +When you ran your gm-world chain in the [build-your-chain guide](/guides/gm-world), it created a `.gm` directory in your `$HOME` directory.guides/create-genesis.md (2)
9-10: Update wording & drop.md.-If you don't have a chain directory yet, you can initialize a simple ignite chain by following [this tutorial](/guides/gm-world.md) +If you don't have a chain directory yet, you can initialize a simple Ignite chain by following [this guide](/guides/gm-world)
30-31: Same issue in second reference.-Ensure that `rollkit.toml` is present in the root of your rollup directory (if not, follow a [Guide](/guides/gm-world.md) 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 the [gm-world guide](/guides/gm-world) to set it up) and run the following command to (re)generate an entry-point binary out of the code:
🧹 Nitpick comments (4)
guides/deploy-overview.md (1)
19-19: LGTM! Path update is correct.The link update to
/guides/docker-compose.mdis consistent with the documentation restructuring.Consider omitting the
.mdextension for VitePress best practices:-* [Deploy with Docker Compose](/guides/docker-compose.md) +* [Deploy with Docker Compose](/guides/docker-compose)guides/da/local-da.md (1)
12-12: LGTM! Path updates are correct and consistent.The link updates to
/guides/quick-start.mdand/guides/gm-world.mdare consistent with the documentation restructuring.Consider omitting the
.mdextensions for VitePress best practices:-Before proceeding, ensure that you have completed the [quick start](/guides/quick-start.md) or [build a chain](/guides/gm-world.md) tutorial, which covers installing the rollkit CLI, building your chain, and running your chain. +Before proceeding, ensure that you have completed the [quick start](/guides/quick-start) or [build a chain](/guides/gm-world) tutorial, which covers installing the rollkit CLI, building your chain, and running your chain.README.md (2)
7-8: Minor grammar: remove superfluous comma.The comma after “guides” interrupts the sentence flow.
-Here you'll find comprehensive guides, and reference materials to help you make the most out of Rollkit. +Here you'll find comprehensive guides and reference materials to help you make the most out of Rollkit.
32-33: Consider clarifying section naming for future readers.The bullet now references
/guides, whereas navigation labels were changed to “How To Guides”. Adding the human-readable label can avoid confusion:-* /guides: Step-by-step instructions to help users build their own rollups with Rollkit. +* /guides (How To Guides): Step-by-step instructions to help users build their own rollups with Rollkit.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
.vitepress/config.ts(4 hunks)README.md(2 hunks)blog/rollkit-the-first-sovereign-rollup-framework.md(1 hunks)guides/create-genesis.md(2 hunks)guides/da/celestia-da.md(2 hunks)guides/da/local-da.md(1 hunks)guides/da/overview.md(2 hunks)guides/deploy-overview.md(1 hunks)guides/docker-compose.md(3 hunks)guides/execution/cosmwasm.md(1 hunks)guides/gm-world.md(1 hunks)guides/reset-state.md(2 hunks)guides/restart-rollup.md(2 hunks)guides/sequencing/overview.md(1 hunks)guides/use-tia-for-gas.md(1 hunks)index.md(1 hunks)learn/about.md(2 hunks)
🧰 Additional context used
🧠 Learnings (5)
guides/execution/cosmwasm.md (8)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
guides/create-genesis.md (6)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-08T09:29:26.874Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
guides/use-tia-for-gas.md (12)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-08T09:29:26.874Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/wasmd.Dockerfile:5-6
Timestamp: 2024-10-08T09:18:01.381Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/wasmd.Dockerfile`, the project chooses not to use a `.dockerignore` file during Docker builds.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/wasmd.Dockerfile:5-6
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/wasmd.Dockerfile`, the project chooses not to use a `.dockerignore` file during Docker builds.
guides/restart-rollup.md (6)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
guides/reset-state.md (6)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
🔇 Additional comments (5)
.vitepress/config.ts (2)
175-175: LGTM! Navigation update is consistent with the documentation restructuring.The change from "Tutorials" to "How To Guides" in the navigation is well-aligned with the PR objective to consolidate documentation sections.
208-321: LGTM! Sidebar restructuring is comprehensive and consistent.The sidebar changes successfully:
- Rename "Tutorials" to "How To Guides"
- Update all internal links from
/tutorials/to/guides/- Maintain the existing navigation structure and hierarchy
All path updates are consistent and align with the documentation restructuring.
index.md (1)
16-16: LGTM! Homepage link update is correct.The Quick start link update to
/guides/quick-startis consistent with the documentation restructuring.learn/about.md (2)
17-18: Verify link target and naming consistency (“Guides” vs “How-To Guides”).The link now points to
/guides/gm-world.md, which assumes the new directory is literally namedguides/.
Other files (e.g..vitepress/config.ts) appear to rename the section to “How To Guides”. If the physical path ends up being something like/how-to-guides/…, this link will break.Action:
- Confirm the final directory/slug for the merged section.
- Update the link (and its anchor text) accordingly.
-[guides section](/guides/gm-world.md) +[How To Guides](/how-to-guides/gm-world.md)
97-98: Same potential path mismatch as above.Ensure the capitalisation and directory name match the eventual location:
-[Guides](/guides/gm-world.md) +[How To Guides](/how-to-guides/gm-world.md)If
/guides/is indeed the canonical path, ignore this suggestion.
tac0turtle
approved these changes
Jul 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Having two folders, tutorials and guides, makes it very confusing. Merging them now into a single how-to guides.
This is not final: there will be a lot of file moving, merging, and rewriting coming up. However, for the sake of keeping a clean and readable Git history, it will be done step by step.
Summary by CodeRabbit