rollkit / docs

Documentation for Rollkit - a modular framework for rollups.
https://rollkit.dev
34 stars 49 forks source link

Added Quick start guide and simplified gm-world tutorial #360

Closed yarikbratashchuk closed 6 months ago

yarikbratashchuk commented 6 months ago

Summary by CodeRabbit

Resolves #361

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

[!NOTE]

Reviews Paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

The recent updates focus on enhancing user navigation and tutorial accessibility in documentation, alongside introducing and refining scripts for streamlined development setups. Key changes include link updates in .vitepress/config.ts, the addition of new setup scripts, and the creation of a new quick start guide in tutorials/quick-start.md.

Changes

File(s) Summary of Changes
.vitepress/config.ts, index.md Updated navigation links and action button text for improved user guidance.
scripts/install-*.sh Added and updated scripts to automate the installation and setup of various development tools and environments.
tutorials/quick-start.md, tutorials/gm-world.md Introduced a new quick start guide and updated tutorial content for clarity and enhanced learning.
tutorials/starter-rollup.md Minor text correction for consistency.

🐰✨📜
In the garden of code, where the snippets do play,
A rabbit hopped by, reshaping the clay.
Links like fresh carrots, scripts sprouting anew,
"To easier learning," he chirped, "we pursue!"
With each line and command, our garden does grow,
Hop, hop, hooray, to the future we go! 🌱🚀
🐰✨📜


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 6 months ago

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

yarikbratashchuk commented 6 months ago

Nice! I'll need to run through this on a new instance myself.

first we need to merge it, otherwise links will not work :)

yarikbratashchuk commented 6 months ago

@jcstein is there a way to create a short links and redirect to raw.githubusercontent.com for our links? From what I checked there is a way to do this with a server, but maybe there is some trick without it?

MSevey commented 6 months ago

@coderabbitai resolve

MSevey commented 6 months ago

@coderabbitai ignore

MSevey commented 6 months ago

Nice! I'll need to run through this on a new instance myself.

first we need to merge it, otherwise links will not work :)

links should work from the preview 👍🏻

jcstein commented 6 months ago

@jcstein is there a way to create a short links and redirect to raw.githubusercontent.com for our links? From what I checked there is a way to do this with a server, but maybe there is some trick without it?

yes i am going to rework this so that it uses the public directory, which hosts things on existing dns rollkit.dev

example use of public folder to retrieve an image in the gm folder https://rollkit.dev/gm/gm.png

it will be as plain text aka the script, an example of this is https://docs.celestia.org/nodes/celestia-node#installing-a-pre-built-binary bash -c "$(curl -sL https://docs.celestia.org/celestia-node.sh)"

jcstein commented 6 months ago

here is proof from local dev that the scripts work as expected

Screenshot 2024-05-03 at 12 09 49 PM
jcstein commented 6 months ago

nervous-ted-striker-gif-by-filmeditor