docs: explain slashing mechanism by Mackenzie-OO7 · Pull Request #1273 · celestiaorg/docs

Mackenzie-OO7 · 2023-11-17T10:55:22Z

Resolves #11

New and updated code has appropriate documentation
New and updated code has new and/or updated testing
Required CI checks are passing
Visual proof for any user facing features like CLI or documentation updates
Linked issues closed with keywords

Summary by CodeRabbit

New Features
- Introduced "Slashing Mechanics" documentation for validators in the sidebar.
Documentation
- Added detailed information on slashing conditions and impacts for Celestia validators and their delegators.

Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com>

Mackenzie-OO7 · 2023-11-27T19:50:43Z

@jcstein please how do I get my PR to pass the PR preview check?

jcstein · 2023-12-12T16:17:06Z

hi, apologies for the delay here! i need to review this again, the deploy pr preview will not be able to be ran as you are from outside the organization, though

rootulp

Thanks for the contribution! A few comments on the language used

Co-authored-by: Rootul P <rootulp@gmail.com>

coderabbitai · 2024-01-24T06:43:20Z

Warning

Rate Limit Exceeded

@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 18 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 55731c5 and 0b967ff.

Walkthrough

The recent update to the Celestia documentation introduces an explanation of the slashing mechanics in the blockchain's consensus process. By adding a new sidebar item and a dedicated markdown page, the update aims to clarify the conditions and consequences of validator penalties to improve the understanding for validators and their delegators.

Changes

File	Change Summary
`.../config.ts`	Added "Slashing Mechanics" to the sidebar for better navigation.
`developers/slashing.md`	Created a new document detailing the purpose, conditions, and impact of slashing mechanics on validators and delegators.

Assessment against linked issues

Objective	Addressed	Explanation
Explain Slashing in the Docs (#11)	✅	The objective is addressed with the creation of `developers/slashing.md` which elaborates on the slashing mechanics.

Poem

In the realm of code, a new tale unfolds,
"Slashing Mechanics," a story now told.
Validators heed, for the rabbit's wise word,
A blockchain kept honest, by rules now conferred. 🐇⚖️

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-tests for this file.
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 tests 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 from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @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.
The JSON schema for the configuration file is available here.
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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 275a779 and 713d98c.

Files selected for processing (2)

.vitepress/config.ts (1 hunks)
developers/slashing.md (1 hunks)

Additional comments: 1

.vitepress/config.ts (1)

715-718: The addition of the "Slashing Mechanics" link to the sidebar is correctly implemented and follows the structure of the existing sidebar configuration.

The new sidebar item "Slashing Mechanics" has been added correctly.

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 713d98c and 177e7b0.

Files selected for processing (1)

.vitepress/config.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

.vitepress/config.ts

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 177e7b0 and 2e29d0e.

Files selected for processing (1)

developers/slashing.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

developers/slashing.md

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 2e29d0e and 55731c5.

Files selected for processing (1)

.vitepress/config.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

.vitepress/config.ts

docs: explain slashing mechanism

40be8de

Mackenzie-OO7 marked this pull request as ready for review November 17, 2023 11:01

Mackenzie-OO7 marked this pull request as draft November 17, 2023 11:02

jcstein self-requested a review November 17, 2023 21:12

jcstein reviewed Nov 20, 2023

View reviewed changes

Comment thread developers/slashing.md Outdated

jcstein reviewed Nov 20, 2023

View reviewed changes

Comment thread developers/slashing.md Outdated

jcstein reviewed Nov 20, 2023

View reviewed changes

Comment thread developers/slashing.md Outdated

jcstein assigned Mackenzie-OO7 Nov 20, 2023

jcstein requested changes Nov 20, 2023

View reviewed changes

Comment thread developers/slashing.md Outdated

Mackenzie-OO7 added 2 commits November 21, 2023 18:10

Merge branch 'celestiaorg:main' into document-slashing

f00df16

docs: update parameters for slashing

b14a134

jcstein added the documentation Improvements or additions to documentation label Nov 21, 2023

Mackenzie-OO7 added 2 commits November 22, 2023 11:10

Merge branch 'celestiaorg:main' into document-slashing

8e95eb4

docs: link specificationss page

8d28e06

jcstein reviewed Nov 22, 2023

View reviewed changes

Comment thread developers/slashing.md Outdated

Update developers/slashing.md

9c6bb66

Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com>

Mackenzie-OO7 requested a review from jcstein November 25, 2023 08:36

Merge branch 'celestiaorg:main' into document-slashing

51f6967

Merge branch 'celestiaorg:main' into document-slashing

5e707fb

Mackenzie-OO7 marked this pull request as ready for review December 19, 2023 11:22

rootulp reviewed Jan 24, 2024

View reviewed changes

Apply suggestions from code review

713d98c

Co-authored-by: Rootul P <rootulp@gmail.com>

coderabbitai bot reviewed Jan 24, 2024

View reviewed changes

Comment thread developers/slashing.md Outdated

Comment thread developers/slashing.md Outdated

Merge branch 'celestiaorg:main' into document-slashing

177e7b0

coderabbitai bot reviewed Jan 24, 2024

View reviewed changes

docs: correct and improve explanations

2e29d0e

coderabbitai bot reviewed Jan 24, 2024

View reviewed changes

jcstein reviewed Jan 24, 2024

View reviewed changes

Comment thread .vitepress/config.ts Outdated

Merge branch 'celestiaorg:main' into document-slashing

55731c5

coderabbitai bot reviewed Jan 30, 2024

View reviewed changes

docs: move slashing doc to node operators section

460fc3c

jcstein reviewed Jan 31, 2024

View reviewed changes

Comment thread .vitepress/config.ts Outdated

jcstein reviewed Jan 31, 2024

View reviewed changes

Comment thread nodes/celestia-app-slashing.md Outdated

Apply suggestions from code review

0b967ff

jcstein approved these changes Jan 31, 2024

View reviewed changes

jcstein merged commit ea57962 into celestiaorg:main Jan 31, 2024

Conversation

Mackenzie-OO7 commented Nov 17, 2023 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mackenzie-OO7 commented Nov 27, 2023

Uh oh!

jcstein commented Dec 12, 2023

Uh oh!

rootulp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot commented Jan 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate Limit Exceeded

Walkthrough

Changes

Assessment against linked issues

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Mackenzie-OO7 commented Nov 17, 2023 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 24, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)