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: use breaking network upgrade for lemongrass #1716

Closed
wants to merge 1 commit into from

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Sep 17, 2024

Overview

Clarifies "breaking network upgrade" based on:

  • Hardfork === Breaking network upgrade
  • Softfork === (non-breaking) Network upgrade

Summary by CodeRabbit

  • New Features

    • Clarified the nature of the "Lemongrass network upgrade" by updating terminology to "Lemongrass breaking network upgrade" across multiple documents, highlighting potential breaking changes for users.
  • Documentation

    • Enhanced clarity on the implications of the Lemongrass upgrade for users regarding compatibility and functionality.

Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Walkthrough

The pull request introduces a critical update across several documentation files, changing the terminology from "Lemongrass network upgrade" to "Lemongrass breaking network upgrade." This adjustment clarifies that the upgrade includes breaking changes, which is essential for users to understand potential impacts on compatibility and functionality.

Changes

Files Change Summary
nodes/arabica-devnet.md Updated reference from "Lemongrass network upgrade" to "Lemongrass breaking network upgrade."
nodes/mainnet.md Changed reference from "Lemongrass network upgrade" to "Lemongrass breaking network upgrade."
nodes/mocha-testnet.md Altered reference to "Lemongrass breaking network upgrade" from "Lemongrass network upgrade."
nodes/network-upgrade-process.md Renamed section title from "Lemongrass network upgrade" to "Lemongrass breaking network upgrade."
nodes/participate.md Modified reference from "Lemongrass network upgrade" to "Lemongrass breaking network upgrade."

Possibly related issues

Possibly related PRs

Suggested labels

documentation, enhancement

🐰 "In the garden, changes bloom,
Lemongrass whispers, dispelling gloom.
Breaking upgrades, a clear new path,
Hop along, avoid the wrath!
With each update, we grow and thrive,
In the world of code, we come alive!" 🌱


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 generate interesting stats about this repository and render them as a table.
    -- @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

github-actions bot commented Sep 17, 2024

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2024-09-18 10:32 UTC

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: 0

Outside diff range and nitpick comments (1)
nodes/network-upgrade-process.md (1)

41-43: LGTM: The section title change accurately reflects the nature of the upgrade.

The content of the section provides clear and detailed information about the upgrade process.

Consider the following minor style improvements:

-The Lemongrass breaking network upgrade includes all of the CIPs listed in [CIP-17](https://github.com/celestiaorg/CIPs/blob/main/cips/cip-17.md).
+The Lemongrass breaking network upgrade includes all the CIPs listed in [CIP-17](https://github.com/celestiaorg/CIPs/blob/main/cips/cip-17.md).

-If you are a consensus node or validator operator: you will need to download and run a celestia-app binary >= v2.0.0 prior to the `--v2-upgrade-height` to remain on the canonical chain.
+If you are a consensus node or validator operator: you will need to download and run a celestia-app binary >= v2.0.0 before the `--v2-upgrade-height` to remain on the canonical chain.
Tools
LanguageTool

[style] ~43-~43: Consider removing “of” to be more concise
Context: ...grass breaking network upgrade includes all of the CIPs listed in [CIP-17](https://github....

(ALL_OF_THE)


[style] ~43-~43: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... download and start a compatible binary prior to the upgrade height. - If you are a con...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9510b6d and c75c1ae.

Files selected for processing (5)
  • nodes/arabica-devnet.md (1 hunks)
  • nodes/mainnet.md (1 hunks)
  • nodes/mocha-testnet.md (1 hunks)
  • nodes/network-upgrade-process.md (1 hunks)
  • nodes/participate.md (1 hunks)
Files skipped from review due to trivial changes (4)
  • nodes/arabica-devnet.md
  • nodes/mainnet.md
  • nodes/mocha-testnet.md
  • nodes/participate.md
Additional context used
LanguageTool
nodes/network-upgrade-process.md

[style] ~43-~43: Consider removing “of” to be more concise
Context: ...grass breaking network upgrade includes all of the CIPs listed in [CIP-17](https://github....

(ALL_OF_THE)


[style] ~43-~43: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... download and start a compatible binary prior to the upgrade height. - If you are a con...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

@jcstein
Copy link
Member Author

jcstein commented Sep 18, 2024

Closing this to move forward with "hardfork" -> "network upgrade" because there was no mention of "softfork" or "non-breaking network upgrade" in either CIP docs or in Celestia docs.

@jcstein jcstein closed this Sep 18, 2024
@jcstein jcstein deleted the jcs/fix-lemongrass branch October 1, 2024 02:08
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.

1 participant