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.

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

feat: links to github instead of scripts, because scripts download automatically #363

Merged
merged 2 commits into from
May 3, 2024

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented May 3, 2024

Overview

This PR makes changes to "handy script" links to show the example on github as opposed to the hosted script on rollkit.dev//init-.sh to avoid the script downloading and to allow the user to preview the script.

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation
    • Updated links to initialization scripts in various tutorials to point to new GitHub repository locations, enhancing accessibility and reliability.
    • Minor text modification in the "Quick Start Guide" title for consistency in documentation style.

@jcstein jcstein requested a review from MSevey May 3, 2024 17:22
@jcstein jcstein self-assigned this May 3, 2024
Copy link
Contributor

coderabbitai bot commented May 3, 2024

Walkthrough

The changes across various tutorials involve updating script URLs from local or outdated links to more accessible GitHub repository links. Additionally, there is a minor text modification in one tutorial for stylistic consistency.

Changes

File Path Change Summary
tutorials/cosmwasm.md Updated script link from rollkit.dev to github.com
tutorials/gm-world-arabica-testnet.md, tutorials/gm-world-mocha-testnet.md Updated script URLs from local to GitHub repository links
tutorials/wordle.md Updated script link from local repository to GitHub repository link
tutorials/gm-world.md Minor text modification: "Quick Start Guide" to "Quick start guide"

🐰✨
In the digital meadow, under the byte-sized sun,
Links hop from old pastures to new ones for fun.
From local to GitHub, with a script in their paws,
They leap with a click, without a single pause.
Oh, how the docs grow, well-tended and bright! 🌟
🐰✨


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between ac4e696 and 4c98bf2.
Files selected for processing (1)
  • tutorials/gm-world.md (1 hunks)
Additional Context Used
LanguageTool (25)
tutorials/gm-world.md (25)

Near line 5: Possible spelling mistake found.
Context: ...ocally and on a testnet --- # GM World Rollup ## 🌞Introduction {#introduction} Thi...


Near line 9: Possible spelling mistake found.
Context: ...through building a sovereign gm-world rollup (gm stands for "good morning") using ...


Near line 9: Possible spelling mistake found.
Context: ... (gm stands for "good morning") using Rollkit. Unlike the [quick start guide](https:/...


Near line 9: Possible spelling mistake found.
Context: ...cal approach to understanding sovereign rollup development. We will cover: - Buildin...


Near line 13: Possible spelling mistake found.
Context: ...uring a Cosmos-SDK application-specific rollup blockchain. - Posting rollup data to a ...


Near line 14: Possible spelling mistake found.
Context: ...n-specific rollup blockchain. - Posting rollup data to a Data Availability (DA) networ...


Near line 30: Possible spelling mistake found.
Context: ...> ## 🛠️ Dependencies {#dependencies} Rollkit uses the [Go programming language](http...


Near line 53: Possible spelling mistake found.
Context: ...7980. ## 🏗️ Building Your Sovereign Rollup {#building-your-sovereign-rollup} With...


Near line 55: Possible spelling mistake found.
Context: ... DA network running, let’s prepare your rollup blockchain. To make it simple we will ...


Near line 57: Possible missing comma found.
Context: ...are your rollup blockchain. To make it simple we will download a repository with a `g...


Near line 57: Possible spelling mistake found.
Context: ...download a repository with a gm-world rollup that has an init.sh script that does ...


Near line 59: Possible spelling mistake found.
Context: ...r you. Download and build a gm-world rollup with an interactive script in a new ter...


Near line 61: Consider a shorter alternative to avoid wordiness.
Context: ... script in a new terminal: ::: warning In order to run it you need to have the jq command ...


Near line 62: Possible spelling mistake found.
Context: ...In order to run it you need to have the jq command line tool installed. You can in...


Near line 62: Possible spelling mistake found.
Context: ...nstalled. You can install it by running sudo apt-get install jq on Ubuntu or brew install jq on macO...


Near line 62: Possible spelling mistake found.
Context: ... sudo apt-get install jq on Ubuntu or brew install jq on macOS. ::: ::: tip If you get error...


Near line 65: Possible spelling mistake found.
Context: ...macOS. ::: ::: tip If you get errors of gmd not found, you may need to add the `go...


Near line 72: Possible spelling mistake found.
Context: ...rollup.sh | sh ``` ## 🚀 Starting Your Rollup {#start-your-rollup} Start the rollup,...


Near line 74: Possible spelling mistake found.
Context: ... Rollup {#start-your-rollup} Start the rollup, posting to the local DA network: ```b...


Near line 110: Possible spelling mistake found.
Context: ...ex ... ``` Good work so far, we have a Rollup node, DA network node, now we can start...


Near line 137: A comma is probably missing here.
Context: ...1lv8c1FWhLpqP"}' type: local ``` For convenience we export two of our keys like this: `...


Near line 144: Possible missing article found.
Context: ... flags, for now, we just want to submit transaction from a high level perspective): ```bas...


Near line 144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... just want to submit transaction from a high level perspective): ```bash gmd tx bank send...


Near line 177: This sentence does not start with an uppercase letter.
Context: ...m and sign the transaction as prompted. now you see the transaction hash at the out...


Near line 223: Possible spelling mistake found.
Context: ... Congratulations! You've built a local rollup that posts to a local DA network. So fa...


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@jcstein jcstein added the documentation Improvements or additions to documentation label May 3, 2024
Copy link
Contributor

github-actions bot commented May 3, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-05-03 19:33 UTC

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

tutorials/wordle.md Show resolved Hide resolved
tutorials/gm-world-mocha-testnet.md Show resolved Hide resolved
tutorials/gm-world-arabica-testnet.md Show resolved Hide resolved
tutorials/gm-world.md Outdated Show resolved Hide resolved
tutorials/gm-world.md Outdated Show resolved Hide resolved
@jcstein jcstein enabled auto-merge (squash) May 3, 2024 19:28
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Out of diff range and nitpick comments (2)
tutorials/gm-world.md (2)

Line range hint 30-30: Update the Go installation script link to point to GitHub as per PR objectives.

- curl -sSL https://rollkit.dev/install-go.sh | sh -s 1.22.2
+ curl -sSL https://github.com/rollkit/docs/blob/main/public/install-go.sh | sh -s 1.22.2

Line range hint 57-57: Update the gm-world rollup script link to point to GitHub as per PR objectives.

- curl -sSL https://rollkit.dev/install-gm-rollup.sh | sh
+ curl -sSL https://github.com/rollkit/docs/blob/main/public/install-gm-rollup.sh | sh

tutorials/gm-world.md Show resolved Hide resolved
@jcstein jcstein merged commit ef5dfe1 into main May 3, 2024
4 checks passed
@jcstein jcstein deleted the jcs/fix-links-to-github-examples branch May 3, 2024 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants