docs icon indicating copy to clipboard operation
docs copied to clipboard

update the slashing page to show there's info on jailing

Open Mackenzie-OO7 opened this issue 1 year ago • 1 comments

closes #1475

Summary by CodeRabbit

  • New Features
    • Updated the sidebar navigation text from "Slashing mechanics" to "Jailing and Slashing mechanics" in the Celestia app.
    • Renamed "Slashing" to "Jailing and Slashing" for validators, with updated conditions including jailing for specific offenses.

Mackenzie-OO7 avatar Apr 29 '24 21:04 Mackenzie-OO7

Walkthrough

The Celestia documentation update involves expanding the scope from "Slashing" to "Jailing and Slashing" for validators, outlining the updated penalties and conditions for Celestia's validators.

Changes

File Path Change Summary
.vitepress/config.ts Updated sidebar navigation text to include "Jailing and Slashing mechanics" for the Celestia app.
nodes/celestia-app-slashing.md Renamed "Slashing" to "Jailing and Slashing"; updated conditions for validator penalties.

Poem

🐇✨ In the docs of Celestia's land, A change was made, isn't it grand? From "Slashing" alone, we expand, To "Jailing and Slashing," as planned. Now clearer for every band, Of validators who must understand. 🌟📜


Recent Review Details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits Files that changed from the base of the PR and between 354eab88c7c6b42c301f095e0446d3e1eac2ebe4 and 3f5d450c059c61ee83e4e633eedfdb7db10d6e57.
Files selected for processing (2)
  • .vitepress/config.ts (1 hunks)
  • nodes/celestia-app-slashing.md (3 hunks)
Additional Context Used
LanguageTool (13)
nodes/celestia-app-slashing.md (13)

Near line 5: Possible spelling mistake found. Context: ...elestia. --- # Jailing and Slashing on Celestia Slashing is a mechanism employed in pr...


Near line 11: Possible spelling mistake found. Context: ...hey act harmfully towards the network. Celestia is built with the Cosmos SDK and uses t...


Near line 14: Possible spelling mistake found. Context: ...` module. If a validator gets slashed, delegators bonded to that validator will also have...


Near line 20: Possible typo: you repeated a whitespace Context: ...ocks, they will be jailed for 1 minute. During this period, the validator is rem...


Near line 22: Possible typo: you repeated a whitespace Context: ... to propose new blocks or earn rewards. After the jail period, the validator can...


Near line 23: Possible spelling mistake found. Context: ... jail period, the validator can send an unjail request to rejoin the validator set....


Near line 26: Possible typo: you repeated a whitespace Context: ...offense and results in getting slashed. If a validator engages in double signing...


Near line 30: Possible spelling mistake found. Context: ...or set and will not have the ability to unjail. Delegators bonded to that validator...


Near line 30: Possible typo: you repeated a whitespace Context: ...nd will not have the ability to unjail. Delegators bonded to that validator will...


Near line 31: Possible spelling mistake found. Context: ...will not have the ability to unjail. Delegators bonded to that validator will automatic...


Near line 31: Possible spelling mistake found. Context: ... validator will automatically enter the unbonding period for 21 days, and can delegate...


Near line 33: Possible spelling mistake found. Context: ...other validator after they have been unbonded. For more details on the jailing and s...


Near line 36: Possible spelling mistake found. Context: ... and slashing parameters, refer to the [celestia-app specifications](https://celestiaorg.git...

Additional comments not posted (4)
nodes/celestia-app-slashing.md (3)

2-2: The updated description accurately reflects the expanded scope of the section to include both jailing and slashing.


5-5: The section title change from "Slashing" to "Jailing and Slashing" is consistent with the updated content and objectives of the PR.


23-37: > :memo: NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [17-27]

Ensure that the detailed conditions for jailing and slashing are accurate and align with the latest Celestia governance policies.

.vitepress/config.ts (1)

470-470: The sidebar navigation text has been correctly updated to "Jailing and Slashing mechanics" to reflect the changes in the documentation content.


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.

coderabbitai[bot] avatar Apr 29 '24 21:04 coderabbitai[bot]