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

Add bridging explanation #2410

Merged
merged 2 commits into from
Dec 11, 2024
Merged

Add bridging explanation #2410

merged 2 commits into from
Dec 11, 2024

Conversation

bob0005
Copy link
Collaborator

@bob0005 bob0005 commented Dec 11, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a "Critical End-Game Information" section detailing the 48-hour closure period after victory.
    • Added a "⚠️ SEASON END CRITICAL INFORMATION" section outlining actions and restrictions when a season ends.
  • Bug Fixes
    • Clarified the withdrawal process and conditions to prevent misunderstandings about resource recovery post-season.
  • Documentation
    • Enhanced organization and clarity of the "Bridging in Eternum" and "Game End" sections.
    • Updated the disclaimer to include mandatory score registration and pro tips for resource management.

Copy link

vercel bot commented Dec 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
eternum ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 11, 2024 11:25am
eternum-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 11, 2024 11:25am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
eternum-landing ⬜️ Ignored (Inspect) Visit Preview Dec 11, 2024 11:25am

Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve significant updates to the documentation concerning the game bridge closure and asset management in the Eternum game. Key modifications include the introduction of new sections that clarify critical end-game information, the restructuring of existing content for improved readability, and the addition of specific warnings regarding resource management during the closure period. The updates aim to ensure players are well-informed about the consequences of their actions as the season ends.

Changes

File Path Change Summary
docs/pages/overview/bridging.mdx Enhanced clarity and structure regarding game bridge closure; added "Critical End-Game Information" section; restructured content on bridging conditions; clarified asset locking rules.
docs/pages/overview/disclaimer.mdx Introduced "⚠️ SEASON END CRITICAL INFORMATION" section; clarified withdrawal process and restrictions; emphasized mandatory score registration within a specified timeframe.

Possibly related PRs

  • Improve readability, add missing info + season payout format #2197: This PR improves readability and adds missing information related to season payout formats, which may connect to the asset management and end-of-season procedures discussed in the main PR.
  • Add visuals to docs #2202: This PR adds visuals to documentation, which could enhance the clarity of the information presented in the main PR regarding game bridge closure and asset management.
  • fix docs build #2274: This PR focuses on formatting improvements in the realm documentation, which may relate to the overall clarity and structure improvements mentioned in the main PR.
  • added hyperstructure warning #2332: This PR introduces a warning related to hyperstructures, which may connect to the asset management and resource handling themes present in the main PR.

🐇 In the land where bunnies play,
We bridge our tokens every day.
With clear warnings, we hop with glee,
Managing assets, so carefree!
As seasons end, we know the score,
With every leap, we learn and explore! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between af5206e and 910aaa4.

📒 Files selected for processing (1)
  • docs/pages/overview/bridging.mdx (2 hunks)

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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

mentatbot bot commented Dec 11, 2024

You are out of MentatBot reviews. Your usage will refresh December 16 at 08:00 AM.

Copy link

Failed to generate code suggestions for PR

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 (2)
docs/pages/overview/bridging.mdx (2)

6-9: Fix typo in critical information section

There's a duplicate word "after" in the message.

-  The Game Bridge **permanently** closes **48 hours** after after victory has been claimed.
+  The Game Bridge **permanently** closes **48 hours** after victory has been claimed.

68-72: Consider using standard markdown list format

While the content is accurate, using blockquotes for a numbered list is unconventional. Consider using standard markdown numbered list format for better consistency.

-> 1. Remove all liquidity from AMM pools **before** the season ends
-> 2. Cancel all open orders on the Order Book **before** the season ends
-> 3. Ensure all resource transfers to your Realm are completed **before** the season ends
-> 4. Bridge out **$LORDS** and **Resources** from your Realm's balance within the 48-hour window
+1. Remove all liquidity from AMM pools **before** the season ends
+2. Cancel all open orders on the Order Book **before** the season ends
+3. Ensure all resource transfers to your Realm are completed **before** the season ends
+4. Bridge out **$LORDS** and **Resources** from your Realm's balance within the 48-hour window
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2bdb72f and af5206e.

📒 Files selected for processing (2)
  • docs/pages/overview/bridging.mdx (2 hunks)
  • docs/pages/overview/disclaimer.mdx (1 hunks)
🔇 Additional comments (7)
docs/pages/overview/bridging.mdx (3)

17-26: LGTM! Clear and comprehensive warning section

The warning effectively communicates critical information about bridge closure and non-bridgeable resources.


59-64: LGTM! Clear enumeration of end-game actions

The section effectively outlines the immediate consequences and available actions during the countdown period.


73-79: LGTM! Clear and prominent final warning

The error callout effectively emphasizes the critical warnings about permanent asset loss.

docs/pages/overview/disclaimer.mdx (4)

30-38: LGTM! Clear presentation of disabled actions

The section effectively communicates the immediate impact of season end on game functionality.


39-48: LGTM! Comprehensive withdrawal window details

The section clearly outlines the withdrawal process and potential blocking conditions.


49-57: LGTM! Clear deadlines and consequences

The section effectively communicates both the permanence of asset locking and the separate deadlines for score registration and prize claiming.


58-60: LGTM! Helpful risk mitigation advice

The pro tip effectively encourages proactive risk management through early bridging.

@aymericdelab aymericdelab merged commit 239a550 into next Dec 11, 2024
24 of 29 checks passed
@aymericdelab aymericdelab deleted the fix/bridge-docs branch December 11, 2024 11:30
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