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

Minor updates to Wordle #373

Merged
merged 13 commits into from
May 13, 2024
Merged

Minor updates to Wordle #373

merged 13 commits into from
May 13, 2024

Conversation

yarikbratashchuk
Copy link
Contributor

@yarikbratashchuk yarikbratashchuk commented May 13, 2024

Is based on the #372, so should go after

Summary by CodeRabbit

  • New Features

    • Added a new tutorial guide on deploying a GM world rollup on Celestia's data availability network.
    • Introduced a new sidebar navigation item for "Celestia" in the documentation.
  • Enhancements

    • Updated the tutorial for building a sovereign rollup to focus on using Rollkit CLI and a mock DA network.
    • Improved installation scripts to automate setup processes and ensure compatibility with user's shell configurations.
  • Bug Fixes

    • Updated the Go version check command in the installation script for better system compatibility.
    • Revised Wordle tutorial content, removing outdated references and enhancing instructional clarity.
  • Documentation

    • Updated links and content in various tutorials to reflect new methodologies and tools.
    • Added a "Next steps" section in the Wordle tutorial to guide users post-setup.

yarikbratashchuk and others added 6 commits May 11, 2024 14:10
* Add celestia-da tutorial, network agnostic

* Update vitepress config

* Add link to /guides/gas-price

* Update tutorials/celestia-da.md

Co-authored-by: joshcs.eth <[email protected]>

* Update tutorials/celestia-da.md

Co-authored-by: joshcs.eth <[email protected]>

* Apply suggestions from code review

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update tutorials/celestia-da.md

* Update tutorials/celestia-da.md

* Update tutorials/celestia-da.md

* Apply suggestions from code review

* Apply suggestions from code review

* Update tutorials/gm-world.md

Co-authored-by: joshcs.eth <[email protected]>

* Remove sudo, we install gmd, no need to use sudo now

* docs: use 1 line for install instead of 2

---------

Co-authored-by: joshcs.eth <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
- Update links to Cosmos SDK docs
- Remove Celestia DA from script and steps
- Add "Next Steps" section pointing to Celestia DA
@yarikbratashchuk yarikbratashchuk self-assigned this May 13, 2024
Copy link
Contributor

coderabbitai bot commented May 13, 2024

Warning

Rate Limit Exceeded

@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 16 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 1c8841c and 6ee3c9f.

Walkthrough

The recent updates focus on enhancing development tools and tutorials, with significant changes in script functionalities and tutorial content. This includes the addition of new scripts for installation and setup, updates to existing tutorials, and the introduction of a new tutorial on deploying a GM world rollup on Celestia's network. Changes aim to streamline processes and update educational resources.

Changes

File Path Change Summary
.vitepress/config.ts Updated sidebar navigation to include "Celestia" tutorial
.vitepress/constants/constants.js Added nodeVersion: "21.7.2" and yarnVersion: "1.22.19"
public/install-gm-frontend-app.sh Added script for GM Frontend app installation
public/install-go.sh Updated Go version check command
public/install-jq.sh Dynamically update $PATH for Homebrew installation
public/install-yarn.sh Script for Node.js, NVM, and Yarn installation
public/wordle/init.sh Changes in Wordle chain initialization
tutorials/celestia-da.md Detailed guide on deploying GM world rollup on Celestia's DA network
tutorials/gm-world.md, tutorials/gm-world-frontend.md Updated tutorial content and imports
tutorials/wordle.md Updated Wordle tutorial content

🐰✨
In the burrows of code, where the digital roots twine,
A rabbit hops through, tweaking lines so fine.
With a whisk of a tail, new scripts come to play,
Celestia's light shines on tutorials today.
Hop, skip, deploy — oh, what a sight!
CodeRabbit celebrates, under the moonlight. 🌙🚀


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.

Copy link
Contributor

github-actions bot commented May 13, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-05-13 21: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: 5

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

Line range hint 55-55: Remove consecutive blank lines to adhere to markdown best practices.

- 
-
tutorials/gm-world.md (1)

Line range hint 42-42: Remove consecutive blank lines to adhere to markdown best practices.

- 
-
tutorials/wordle.md (3)

Line range hint 156-156: Ensure table formatting is consistent with trailing pipes.

- | File/directory | Purpose                                                                                                                                                               |
+ | File/directory | Purpose                                                                                                                                                               | |

285-285: Review the use of cryptographic functions for non-cryptographic purposes.

Using SHA-256 for generating indices might be overkill and could be replaced with simpler hashing mechanisms if cryptographic properties are not required.


548-548: Ensure consistent error messages and consider user experience when displaying errors.

Refining error messages to be more user-friendly can improve the user experience significantly. For example, instead of "Guess Must Only Consist of Alphabet Letters!", consider "Please ensure your guess contains only alphabet letters."

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 8840797 and f5a0cdb.
Files selected for processing (11)
  • .vitepress/config.ts (1 hunks)
  • .vitepress/constants/constants.js (1 hunks)
  • public/install-gm-frontend-app.sh (1 hunks)
  • public/install-go.sh (1 hunks)
  • public/install-jq.sh (1 hunks)
  • public/install-yarn.sh (1 hunks)
  • public/wordle/init.sh (2 hunks)
  • tutorials/celestia-da.md (1 hunks)
  • tutorials/gm-world-frontend.md (1 hunks)
  • tutorials/gm-world.md (3 hunks)
  • tutorials/wordle.md (9 hunks)
Files skipped from review due to trivial changes (2)
  • .vitepress/config.ts
  • public/install-gm-frontend-app.sh
Additional Context Used
ShellCheck (18)
public/install-go.sh (4)

[info] 31-31: Double quote to prevent globbing and word splitting.


[info] 31-31: Double quote to prevent globbing and word splitting.


[info] 31-31: Double quote to prevent globbing and word splitting.


[warning] 114-114: ShellCheck can't follow non-constant source. Use a directive to specify location.

public/install-jq.sh (4)

[error] 3-3: Couldn't find 'fi' for this 'if'.


[error] 3-3: Couldn't parse this if expression. Fix to allow more checks.


[error] 40-40: Expected 'fi' matching previously mentioned 'if'.


[error] 40-40: Expected 'fi'. Fix any mentioned problems and try again.

public/install-yarn.sh (8)

[warning] 33-33: In POSIX sh, 'source' in place of '.' is undefined.


[warning] 33-33: ShellCheck can't follow non-constant source. Use a directive to specify location.


[info] 36-36: Double quote to prevent globbing and word splitting.


[info] 39-39: Double quote to prevent globbing and word splitting.


[info] 44-44: Double quote to prevent globbing and word splitting.


[info] 48-48: Double quote to prevent globbing and word splitting.


[info] 48-48: Double quote to prevent globbing and word splitting.


[info] 48-48: Double quote to prevent globbing and word splitting.

public/wordle/init.sh (2)

[warning] 7-7: CHAINFLAG appears unused. Verify use (or export if used externally).


[info] 36-36: Double quote to prevent globbing and word splitting.

Additional comments not posted (5)
.vitepress/constants/constants.js (1)

4-6: The addition of nodeVersion and yarnVersion constants is correctly implemented and follows best practices by using Object.freeze.

tutorials/gm-world-frontend.md (1)

3-3: Correctly updated the import statement to use constants from the .vitepress/constants/constants.js file.

public/install-go.sh (1)

120-120: The update to dynamically determine the Go executable path using $(which go) is a good practice, enhancing the script's flexibility and compatibility.

tutorials/celestia-da.md (1)

1-119: The new tutorial for deploying a GM world rollup on Celestia's network is comprehensive and well-structured, providing clear instructions and appropriate use of markdown.

tutorials/gm-world.md (1)

2-2: The updated description aligns well with the new focus of the tutorial on using only Rollkit CLI and a mock DA network.

tutorials/wordle.md Show resolved Hide resolved
tutorials/wordle.md Outdated Show resolved Hide resolved
public/install-jq.sh Outdated Show resolved Hide resolved
public/install-yarn.sh Outdated Show resolved Hide resolved
public/wordle/init.sh Show resolved Hide resolved
yarikbratashchuk and others added 2 commits May 13, 2024 12:36
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
tutorials/wordle.md Outdated Show resolved Hide resolved
Follow instructions to install and start your Celestia Data Availability
layer Light Node selecting the Arabica Devnet. You can
find instructions to install and run the node [here](https://docs.celestia.org/nodes/light-node).
### 🪶 Run a mock DA node {#run-mock-da-node}
Copy link
Member

Choose a reason for hiding this comment

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

btw these {#headings} are for custom anchors, where for example, the emoji would make the linkable heading ugly. https://vitepress.dev/guide/markdown#custom-anchors

tutorials/wordle.md Outdated Show resolved Hide resolved
tutorials/wordle.md Outdated Show resolved Hide resolved
@jcstein jcstein merged commit 7228f09 into main May 13, 2024
4 checks passed
@jcstein jcstein deleted the yarik/wordle branch May 13, 2024 21:33
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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between f5a0cdb and 1c8841c.
Files selected for processing (2)
  • tutorials/gm-world-frontend.md (1 hunks)
  • tutorials/wordle.md (9 hunks)
Files not reviewed due to errors (1)
  • tutorials/wordle.md (no review received)
Files skipped from review as they are similar to previous changes (1)
  • tutorials/gm-world-frontend.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants