docs: add nakama and evm docker image version on world.toml explanation

[zulkhair]

Closes: WORLD-1274

Overview

Add explanation in world.toml to use specific nakama and evm docker image using NAKAMA_IMAGE, NAKAMA_IMAGE_PLATFORM, EVM_MAGE, and EVM_IMAGE_PLATFORM

Brief Changelog

add section on /cardinal/game/configuration/nakama and /cardinal/game/configuration/evm

Testing and Verifying

Summary by CodeRabbit

• New Features

  • Introduced new configuration parameters for EVM: EVM_IMAGE and EVM_IMAGE_PLATFORM, enhancing user customization options.
  • Added new configuration options for Nakama: NAKAMA_IMAGE and NAKAMA_IMAGE_PLATFORM, allowing users to specify image versions and platforms.

• Documentation

  • Updated documentation to include descriptions and examples for the new configuration parameters for both EVM and Nakama.

[graphite-app]

Your org has enabled the Graphite merge queue for merging into main

Add the label “graphite/merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

[coderabbitai]

Walkthrough

The pull request introduces new configuration parameters in the documentation for both the Ethereum Virtual Machine (EVM) and Nakama. Specifically, it adds EVM_IMAGE and EVM_IMAGE_PLATFORM to the EVM documentation, and NAKAMA_IMAGE and NAKAMA_IMAGE_PLATFORM to the Nakama documentation. Each new parameter includes descriptions and examples to guide users in setting their Docker images according to their platform requirements.

Changes

File Path	Change Summary
docs/cardinal/game/configuration/evm.mdx	Added new configuration parameters: EVM_IMAGE and EVM_IMAGE_PLATFORM with descriptions and examples.
docs/cardinal/game/configuration/nakama.mdx	Added new configuration parameters: NAKAMA_IMAGE and NAKAMA_IMAGE_PLATFORM with descriptions and examples.

Assessment against linked issues

Objective	Addressed	Explanation
Add explanation for new fields: NAKAMA_IMAGE, NAKAMA_IMAGE_PLATFORM, EVM_IMAGE, EVM_IMAGE_PLATFORM (WORLD-1274)	✅

Possibly related PRs

• docs: add world.toml explanation docs #802: The changes in this PR also involve updates to the docs/cardinal/game/configuration/nakama.mdx file, which is related to configuration parameters, similar to the changes made in the evm.mdx file in the main PR.

Suggested labels

Cardinal

Suggested reviewers

• smsunarto

---

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

[zulkhair]

• docs: add nakama and evm docker image version on world.toml explanation #813 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

Preview Instructions

To preview these changes locally, checkout this branch and run:

make world-docs

[coderabbitai]

Actionable comments posted: 10

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between c43e0ca and 28c657b.

📒 Files selected for processing (2)

• docs/cardinal/game/configuration/evm.mdx (2 hunks)
• docs/cardinal/game/configuration/nakama.mdx (2 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/cardinal/game/configuration/nakama.mdx

[uncategorized] ~83-~83: You might be missing the article “the” here.
Context: ...FORM Set nakama docker image platform, default value will follow the os platform. this...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[github-actions]

Preview Instructions

To preview these changes locally, checkout this branch and run:

make world-docs

[coderabbitai]

Actionable comments posted: 6

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 28c657b and 2ed6766.

📒 Files selected for processing (2)

• docs/cardinal/game/configuration/evm.mdx (2 hunks)
• docs/cardinal/game/configuration/nakama.mdx (2 hunks)

🧰 Additional context used

📓 Learnings (2)

docs/cardinal/game/configuration/evm.mdx (2)

Learnt from: ezavada
PR: Argus-Labs/world-engine#813
File: docs/cardinal/game/configuration/evm.mdx:96-97
Timestamp: 2024-11-19T15:23:54.453Z
Learning: For Cardinal v1.7.1 and later, the EVM image must be `v1.5.1` or later.

Learnt from: ezavada
PR: Argus-Labs/world-engine#813
File: docs/cardinal/game/configuration/evm.mdx:96-97
Timestamp: 2024-11-19T15:26:48.261Z
Learning: For Cardinal v1.6.x and earlier, the EVM image must be `v1.4.1` or earlier.

docs/cardinal/game/configuration/nakama.mdx (1)

Learnt from: ezavada
PR: Argus-Labs/world-engine#813
File: docs/cardinal/game/configuration/nakama.mdx:14-15
Timestamp: 2024-11-19T15:23:54.273Z
Learning: In `docs/cardinal/game/configuration/nakama.mdx`, differences in version numbers between the configuration block and the detailed examples for `NAKAMA_IMAGE` are intentional.

🔇 Additional comments (2)

docs/cardinal/game/configuration/nakama.mdx (1)

14-15: LGTM! Configuration block is well-formatted.

The new configuration options are properly documented with appropriate quotation marks for string values.

docs/cardinal/game/configuration/evm.mdx (1)

16-17: LGTM! TOML syntax is correct.

The configuration parameters are properly formatted with quoted string values, following TOML syntax guidelines.