docs: use `breaking network upgrade` for lemongrass

jcstein commented 2 months ago

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.

coderabbitai[bot] commented 2 months ago

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

celestiaorg/docs#1675: This issue suggests linking the network upgrades section to the hardfork section, which could benefit from the clarified terminology introduced in this PR.

Possibly related PRs

#1641: Updates documentation for the Lemongrass hardfork, directly related to the terminology changes in this PR.
#1663: Clarifies the upgrade process for the Lemongrass hardfork, aligning with the focus on breaking changes.
#1666: Includes updates to the hardfork process documentation mentioning the Lemongrass upgrade, relevant to this PR's changes.
#1672: Updates the Mocha upgrade height in the context of the Lemongrass upgrade, which relates to this PR.
#1677: Adds links to the hardfork process page, enhancing clarity regarding the Lemongrass upgrade discussed in this PR.
#1695: Updates documentation regarding the v2 upgrade height for the mainnet beta, part of the broader context of the Lemongrass upgrade.
#1714: Changes a heading to reflect the term "lemongrass network upgrade," directly aligning with the terminology focus of this PR.

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

github-actions[bot] commented 2 months ago

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

jcstein commented 2 months ago

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.

celestiaorg / docs