Skip to content

docs: add note about slashing#1568

Merged
rach-id merged 1 commit intomainfrom
jcs/bx
May 22, 2024
Merged

docs: add note about slashing#1568
rach-id merged 1 commit intomainfrom
jcs/bx

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented May 10, 2024

Overview

Summary by CodeRabbit

  • Documentation
    • Added a warning in the documentation about Blobstream X being in beta and that slashing is not yet enabled.

@jcstein jcstein requested a review from adlerjohn May 10, 2024 19:27
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 10, 2024

Walkthrough

This update introduces a cautionary note to the Blobstream X documentation, highlighting that the feature is still in its beta phase and that the slashing mechanism is not yet active. This serves to inform users about the current state and limitations of Blobstream X, ensuring they are aware of its experimental nature.

Changes

File Path Change Summary
developers/.../blobstream.md Added a warning about Blobstream X being in beta and no slashing yet.

Poem

🐰✨
In the realm of code, where streams of blobs flow,
A rabbit hopped in, with updates in tow.
"Beware," it squeaked, with a twinkle in its eye,
"For Blobstream X is still quite shy!"
Beta it is, so handle with care,
No slashing yet, but soon, we swear! 🌟
🐰💻


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 enabled auto-merge (squash) May 10, 2024 19:27
@github-actions
Copy link
Copy Markdown
Contributor

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1568/
on branch main at 2024-05-10 19:28 UTC

Copy link
Copy Markdown
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

Out of diff range and nitpick comments (2)
developers/blobstream.md (2)

Line range hint 11-11: Check for possible missing closing bracket for the link syntax.


Line range hint 115-115: Ensure the range notation is correctly closed with a closing bracket.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 26e744f and 0bbbd06.
Files selected for processing (1)
  • developers/blobstream.md (1 hunks)
Additional Context Used
LanguageTool (2)
developers/blobstream.md (2)

Near line 11: Unpaired symbol: ‘[’ seems to be missing
Context: ...ng) ## What is Blobstream? [Blobstream](https://blog.celestia.org/introducing-b...


Near line 115: Unpaired symbol: ‘]’ seems to be missing
Context: ...hes. These ranges can be constructed as [latestBlock, customTargetBlock), with `...

Additional comments not posted (1)
developers/blobstream.md (1)

165-167: The warning about Blobstream X being in beta and slashing not being enabled is clear and appropriately placed. This is crucial information for users and developers interacting with the system.

@rach-id rach-id disabled auto-merge May 10, 2024 19:35
Copy link
Copy Markdown
Member

@rach-id rach-id left a comment

Choose a reason for hiding this comment

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

requesting changes so we don't merge by accident

@jcstein jcstein marked this pull request as draft May 10, 2024 19:37
@rach-id rach-id marked this pull request as ready for review May 22, 2024 16:06
@rach-id rach-id merged commit 7acd10d into main May 22, 2024
@rach-id rach-id deleted the jcs/bx branch May 22, 2024 16:07
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