Feat/docs storage

[spaghettiOnToast]

• Note: now in line with main
• Update Storage formatNumberWithCommas
• Smol design and copy
• Styles
• Add Wonder image

Summary by CodeRabbit

• New Features

  • Added a "Bridge Closure" section in the bridging documentation, highlighting critical timelines for players.
  • Introduced a new sidebar item for "Bridge Closure - MUST READ" in the navigation.

• Bug Fixes

  • Updated the URL for the "Play Eternum" link in the Quick Links section.

• Documentation

  • Enhanced clarity in various documentation files, including updates to formatting and content related to Hyperstructures, rewards, and combat mechanics.

• Style

  • Improved formatting and readability in multiple documents, including the ResourceTable and various mechanics pages.

• Chores

  • Updated .gitignore to include new entries for ignored files.

[vercel]

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 0:06am
eternum-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 11, 2024 0:06am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
eternum-landing	⬜️ Ignored (Inspect)	Visit Preview		Dec 11, 2024 0:06am

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several changes across multiple files, primarily focusing on updates to the .gitignore file, enhancements in the BuildingCard and ResourceTable components, and various modifications to documentation files. Key changes include the addition of new formatting functions for number representation, updates to styling in components, and improved clarity in game mechanics and reward systems documentation. Overall, the changes aim to enhance the structure, readability, and consistency of the codebase and documentation.

Changes

File	Change Summary
.gitignore	Added entries for .snfoundry_cache and docs/dist.
docs/components/BuildingCard.tsx	Changed image layout from a two-column to a three-column grid when multipleImages prop is true.
docs/components/ResourceTable.tsx	Updated table border styling to border-gray-700 for the table and border-gray-500 for header and data cells.
docs/pages/mechanics/hyperstructures.mdx	Updated formatting function from formatNumberWithSpaces to formatNumberWithCommas and added new content.
docs/pages/mechanics/key-concepts.mdx	Added new imports for formatNumberWithCommas and HYPERSTRUCTURE_POINTS_FOR_WIN, clarified victory conditions.
docs/pages/mechanics/military/combat.mdx	Enhanced readability and structure of combat mechanics documentation.
docs/pages/mechanics/realm/buildings.mdx	Removed image reference for "Dragonhide" and improved formatting of sections.
docs/pages/mechanics/realm/realm.mdx	Updated formatting function from formatNumberWithSpaces to formatNumberWithCommas.
docs/pages/mechanics/realm/wonders.mdx	Added an image at the beginning and clarified the exclusivity of Wonders.
docs/pages/mechanics/resources/storage.mdx	Updated formatting function from formatNumberWithSpaces to formatNumberWithCommas.
docs/pages/mechanics/trading.mdx	Added new imports for dynamic transport capacity calculation and emphasized bank attack implications.
docs/pages/mechanics/tribes.mdx	Reformatted bullet points for better readability.
docs/pages/mechanics/world-map.mdx	Adjusted bullet point formatting and improved clarity in mine descriptions.
docs/pages/overview/bridging.mdx	Introduced a new section on "Bridge Closure" with critical player information.
docs/pages/overview/controller.mdx	Updated Passkeys section with detailed setup and functionality information.
docs/pages/overview/disclaimer.mdx	Added details on claiming individual rewards within a specified timeframe.
docs/pages/overview/entry.mdx	Reformatted sections for clarity and expanded details on marketplace and synthetic realms.
docs/pages/overview/links.mdx	Updated the URL for the "Play Eternum" link.
docs/pages/seasons/rewards.mdx	Updated formatting function and clarified the reward claiming process.
docs/utils/formatting.tsx	Introduced a new function formatNumberWithCommas for number formatting.
eliza	Updated subproject commit identifier.
vocs.config.ts	Added "Bridge Closure - MUST READ" to the sidebar and removed "Common issues".

Possibly related PRs

• Add visuals to docs #2202: Updates to the .gitignore file related to documentation structure enhancements.
• Use comma separated number formatting everywhere #2255: Changes to the .gitignore file may relate to consistent number formatting across the project.
• feat(docs): provide general updates #2257: General updates and polish in documentation connected to the .gitignore file changes.
• feat(docs): Fix updates #2331: Improvements in project structure and clarity related to the .gitignore file updates.
• added hyperstructure warning #2332: Updates in the CoOwners component may connect to broader project updates, including the .gitignore.
• Docs missing info #2337: Enhancements in the key-concepts.mdx document related to clarity and detail improvements tied to the .gitignore.

Suggested reviewers

• bob0005

Poem

🐰 In the code where rabbits play,
Changes hop in bright array.
With commas now, our numbers shine,
Documentation, clear and fine.
From buildings tall to bridges wide,
In every file, our joy and pride! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4200015 and 7468636.

⛔ Files ignored due to path filters (130)

• contracts/src/.DS_Store is excluded by !**/.DS_Store
• docs/dist/.vocs/icons/arrow-diagonal.svg is excluded by !**/dist/**, !**/*.svg
• docs/dist/.vocs/icons/chevron-down.svg is excluded by !**/dist/**, !**/*.svg
• docs/dist/.vocs/icons/chevron-up.svg is excluded by !**/dist/**, !**/*.svg
• docs/dist/.vocs/icons/link.svg is excluded by !**/dist/**, !**/*.svg
• docs/dist/.vocs/search-index-9543179b.json is excluded by !**/dist/**
• docs/dist/03.png is excluded by !**/dist/**, !**/*.png
• docs/dist/assets/ResourceIcon-NhE1jPAw.js is excluded by !**/dist/**
• docs/dist/assets/achievements-BlE-atHG.js is excluded by !**/dist/**
• docs/dist/assets/buildings-C8fBf7NE.js is excluded by !**/dist/**
• docs/dist/assets/client-D62oF6PS.js is excluded by !**/dist/**
• docs/dist/assets/collaborators-B3gfP-YX.js is excluded by !**/dist/**
• docs/dist/assets/combat-BU6UlTeW.js is excluded by !**/dist/**
• docs/dist/assets/common-issues-CTtIIpEo.js is excluded by !**/dist/**
• docs/dist/assets/contracts-C_m1afJu.js is excluded by !**/dist/**
• docs/dist/assets/controller-C0ityINQ.js is excluded by !**/dist/**
• docs/dist/assets/disclaimer-i9qmu5-h.js is excluded by !**/dist/**
• docs/dist/assets/entry-DCXiEoGj.js is excluded by !**/dist/**
• docs/dist/assets/formatting-BRYgnMon.js is excluded by !**/dist/**
• docs/dist/assets/getting-started-DOWBpLig.js is excluded by !**/dist/**
• docs/dist/assets/hyperstructures-B_UY0vml.js is excluded by !**/dist/**
• docs/dist/assets/index-BIPCrvl3.js is excluded by !**/dist/**
• docs/dist/assets/index-CFU4aG6t.js is excluded by !**/dist/**
• docs/dist/assets/index-CybB_dSQ.js is excluded by !**/dist/**
• docs/dist/assets/index-D1VnJ4UU.js is excluded by !**/dist/**
• docs/dist/assets/introduction-CRuJJWfe.js is excluded by !**/dist/**
• docs/dist/assets/key-concepts-DjeuZGL5.js is excluded by !**/dist/**
• docs/dist/assets/links-Ce9NPb1c.js is excluded by !**/dist/**
• docs/dist/assets/overview-BVimwG__.js is excluded by !**/dist/**
• docs/dist/assets/production-Dp4SD0hz.js is excluded by !**/dist/**
• docs/dist/assets/realm-Cu_35mC0.js is excluded by !**/dist/**
• docs/dist/assets/resources-D6mDINbp.js is excluded by !**/dist/**
• docs/dist/assets/rewards-BcRcxEkF.js is excluded by !**/dist/**
• docs/dist/assets/sdk-DQtYkepm.js is excluded by !**/dist/**
• docs/dist/assets/storage-CEG2GszP.js is excluded by !**/dist/**
• docs/dist/assets/style-DhXpGyKZ.css is excluded by !**/dist/**
• docs/dist/assets/trading-CNrBzNNB.js is excluded by !**/dist/**
• docs/dist/assets/tribes-CeyQFlT_.js is excluded by !**/dist/**
• docs/dist/assets/units-CrL81k6H.js is excluded by !**/dist/**
• docs/dist/assets/wonders-B8v6Iawg.js is excluded by !**/dist/**
• docs/dist/assets/world-map-YMDt_mzd.js is excluded by !**/dist/**
• docs/dist/buildings/archery.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/bank.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/barracks.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/farm.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/fishing_village.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/forge.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/fragment_mine.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/hyperstructure.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/lumber_mill.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/market.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/mine.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/stable.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/storehouse.png is excluded by !**/dist/**, !**/*.png
• docs/dist/buildings/workers_hut.png is excluded by !**/dist/**, !**/*.png
• docs/dist/controller.png is excluded by !**/dist/**, !**/*.png
• docs/dist/development/client/index.html is excluded by !**/dist/**
• docs/dist/development/collaborators/index.html is excluded by !**/dist/**
• docs/dist/development/common-issues/index.html is excluded by !**/dist/**
• docs/dist/development/contracts/index.html is excluded by !**/dist/**
• docs/dist/development/getting-started/index.html is excluded by !**/dist/**
• docs/dist/development/index.html is excluded by !**/dist/**
• docs/dist/development/sdk/index.html is excluded by !**/dist/**
• docs/dist/eternum_documentation.png is excluded by !**/dist/**, !**/*.png
• docs/dist/eternum_new_logo.svg is excluded by !**/dist/**, !**/*.svg
• docs/dist/eternum_words_logo.svg is excluded by !**/dist/**, !**/*.svg
• docs/dist/index.html is excluded by !**/dist/**
• docs/dist/initializeTheme.iife.js is excluded by !**/dist/**
• docs/dist/logos/BuiltDojo.svg is excluded by !**/dist/**, !**/*.svg
• docs/dist/logos/Cartridge.png is excluded by !**/dist/**, !**/*.png
• docs/dist/logos/Dojo.svg is excluded by !**/dist/**, !**/*.svg
• docs/dist/logos/RealmsWorld.png is excluded by !**/dist/**, !**/*.png
• docs/dist/logos/Starknet.png is excluded by !**/dist/**, !**/*.png
• docs/dist/map.png is excluded by !**/dist/**, !**/*.png
• docs/dist/mechanics/achievements/index.html is excluded by !**/dist/**
• docs/dist/mechanics/hyperstructures/index.html is excluded by !**/dist/**
• docs/dist/mechanics/key-concepts/index.html is excluded by !**/dist/**
• docs/dist/mechanics/military/combat/index.html is excluded by !**/dist/**
• docs/dist/mechanics/military/units/index.html is excluded by !**/dist/**
• docs/dist/mechanics/realm/buildings/index.html is excluded by !**/dist/**
• docs/dist/mechanics/realm/realm/index.html is excluded by !**/dist/**
• docs/dist/mechanics/realm/wonders/index.html is excluded by !**/dist/**
• docs/dist/mechanics/resources/production/index.html is excluded by !**/dist/**
• docs/dist/mechanics/resources/resources/index.html is excluded by !**/dist/**
• docs/dist/mechanics/resources/storage/index.html is excluded by !**/dist/**
• docs/dist/mechanics/trading/index.html is excluded by !**/dist/**
• docs/dist/mechanics/tribes/index.html is excluded by !**/dist/**
• docs/dist/mechanics/world-map/index.html is excluded by !**/dist/**
• docs/dist/og-image.png is excluded by !**/dist/**, !**/*.png
• docs/dist/overview/controller/index.html is excluded by !**/dist/**
• docs/dist/overview/disclaimer/index.html is excluded by !**/dist/**
• docs/dist/overview/entry/index.html is excluded by !**/dist/**
• docs/dist/overview/introduction/index.html is excluded by !**/dist/**
• docs/dist/overview/links/index.html is excluded by !**/dist/**
• docs/dist/resources/1.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/10.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/11.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/12.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/13.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/14.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/15.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/16.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/17.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/18.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/19.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/2.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/20.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/21.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/22.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/249.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/250.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/251.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/252.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/253.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/254.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/255.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/29.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/3.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/4.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/5.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/6.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/7.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/8.png is excluded by !**/dist/**, !**/*.png
• docs/dist/resources/9.png is excluded by !**/dist/**, !**/*.png
• docs/dist/ring_pass.png is excluded by !**/dist/**, !**/*.png
• docs/dist/seasons/overview/index.html is excluded by !**/dist/**
• docs/dist/seasons/rewards/index.html is excluded by !**/dist/**
• docs/public/bridge.png is excluded by !**/*.png
• docs/public/buildings/dragonhide.png is excluded by !**/*.png
• docs/public/buildings/wonder.png is excluded by !**/*.png

📒 Files selected for processing (22)

• .gitignore (1 hunks)
• docs/components/BuildingCard.tsx (1 hunks)
• docs/components/ResourceTable.tsx (2 hunks)
• docs/pages/mechanics/hyperstructures.mdx (5 hunks)
• docs/pages/mechanics/key-concepts.mdx (2 hunks)
• docs/pages/mechanics/military/combat.mdx (2 hunks)
• docs/pages/mechanics/realm/buildings.mdx (1 hunks)
• docs/pages/mechanics/realm/realm.mdx (2 hunks)
• docs/pages/mechanics/realm/wonders.mdx (1 hunks)
• docs/pages/mechanics/resources/storage.mdx (2 hunks)
• docs/pages/mechanics/trading.mdx (3 hunks)
• docs/pages/mechanics/tribes.mdx (1 hunks)
• docs/pages/mechanics/world-map.mdx (2 hunks)
• docs/pages/overview/bridging.mdx (1 hunks)
• docs/pages/overview/controller.mdx (2 hunks)
• docs/pages/overview/disclaimer.mdx (1 hunks)
• docs/pages/overview/entry.mdx (1 hunks)
• docs/pages/overview/links.mdx (1 hunks)
• docs/pages/seasons/rewards.mdx (2 hunks)
• docs/utils/formatting.tsx (1 hunks)
• eliza (1 hunks)
• vocs.config.ts (1 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[mentatbot]

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