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

docs: readme #2157

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: readme #2157

wants to merge 1 commit into from

Conversation

Olexandr88
Copy link
Contributor

@Olexandr88 Olexandr88 commented Nov 15, 2024

In my opinion, the new link will be considered more correct. Even the Beacon-kit main site links to this link

Summary by CodeRabbit

  • Documentation
    • Updated the Telegram chat link in the README file to direct users to the new Berachain Portal.

Signed-off-by: Olexandr88 <radole1203@gmail.com>
Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

Walkthrough

The changes in this pull request focus on updating the Telegram chat link in the README.md file. The link has been changed from https://t.me/beacon_kit to https://t.me/BerachainPortal. This is the only modification made, with no alterations to the document's structure or other content.

Changes

File Change Summary
README.md Updated Telegram chat link from https://t.me/beacon_kit to https://t.me/BerachainPortal.

Possibly related PRs

  • Docs: Update README #2009: The changes in this PR also involve updates to the README.md file, specifically enhancing user experience through the addition of hyperlinks, similar to the link update in the main PR.

Suggested reviewers

  • ocnc
  • itsdevbear

🐰 "In the meadow, changes bloom,
A link updated, dispelling gloom.
From one chat to another, we hop,
Join us now, don’t let this drop!
With a click, the journey starts,
Together we'll share our hearts!" 🐇✨


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 8a04173 and 95173b4.

📒 Files selected for processing (1)
  • README.md (1 hunks)

@@ -17,7 +17,7 @@ _The project is still heavily under construction, see the [disclaimer below](#st

[![CI status](https://github.com/berachain/beacon-kit/workflows/pipeline/badge.svg)](https://github.com/berachain/beacon-kit/actions/workflows/pipeline.yml)
[![CodeCov](https://codecov.io/gh/berachain/beacon-kit/graph/badge.svg?token=0l5iJ3ZbzV)](https://codecov.io/gh/berachain/beacon-kit)
[![Telegram Chat](https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fbeacon_kit)](https://t.me/beacon_kit)
[![Telegram Chat](https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fbeacon_kit)](https://t.me/BerachainPortal)
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Inconsistency detected in Telegram badge configuration

The search results reveal a mismatch between the badge configuration and the actual link:

  • The badge URL still points to beacon_kit (tg.sumanjay.workers.dev/beacon_kit)
  • But the clickable link redirects to BerachainPortal (t.me/BerachainPortal)

This inconsistency should be fixed by updating both URLs to use BerachainPortal.

🔗 Analysis chain

Verify the new Telegram link and its consistency

The link update from beacon_kit to BerachainPortal appears to align with the main site. Let's verify the links and consistency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify Telegram links and consistency across the codebase

# Check if there are any other references to the old Telegram link
echo "Checking for other occurrences of the old Telegram link..."
rg -i "beacon_kit" --type md

# Check if there are any existing references to the new Telegram link
echo "Checking for existing references to the new Telegram link..."
rg -i "BerachainPortal" --type md

# Check if the README mentions the Telegram link anywhere else
echo "Checking for other Telegram references in README..."
rg -i "telegram" README.md

# Look for any documentation files that might need updates
echo "Checking for documentation files that might need updates..."
fd -e md -e mdx

Length of output: 1390

Copy link
Contributor

@nidhi-singh02 nidhi-singh02 left a comment

Choose a reason for hiding this comment

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

Even the Beacon-kit main site links to this link Could you pls elaborate this. Are you referring to Berachain website here ?

@Olexandr88
Copy link
Contributor Author

Even the Beacon-kit main site links to this link Could you pls elaborate this. Are you referring to Berachain website here ?

Знімок екрана 2024-11-15 о 21 42 29

Copy link
Collaborator

@chuck-bear chuck-bear left a comment

Choose a reason for hiding this comment

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

This is not the same TG group. What's the motivation here?

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.

3 participants