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

chore: clean up our README to be less Celestia centric. #1639

Merged
merged 2 commits into from
Apr 25, 2024

Conversation

MSevey
Copy link
Contributor

@MSevey MSevey commented Apr 23, 2024

Overview

This updates the README to be more aligned with how the docs are structured.

It removes all the Celestia specific information and the compatibility table.

@MSevey MSevey self-assigned this Apr 23, 2024
Copy link
Contributor

coderabbitai bot commented Apr 23, 2024

Walkthrough

The recent update to the Rollkit project primarily enhances the README.md file. It improves user navigation by updating web links, clarifies section headings for better understanding, and introduces a quick start command for the Rollkit CLI, making it more accessible for new users.

Changes

File Changes
README.md Updated web links, refined section headings, added quick start command for Rollkit CLI

🌟🐰📜
In the meadow of code, under the sky so wide,
A little rabbit hopped with pride.
Links like streams, now clearer flow,
Headings like trees, in order stand so.
A command sprouts, quick and bright—
Start your journey, into the night!
🌟🐰📜


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

@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

README.md Show resolved Hide resolved
@tzdybal tzdybal enabled auto-merge April 25, 2024 19:36
@tzdybal tzdybal added this pull request to the merge queue Apr 25, 2024
Merged via the queue into main with commit 14690f9 Apr 25, 2024
20 checks passed
@tzdybal tzdybal deleted the sevey/readme-update branch April 25, 2024 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants