Skip to content

feat(docs): add i18n support with Chinese translations#31

Open
OS-Lihua wants to merge 2 commits intohyperlane-xyz:mainfrom
OS-Lihua:main
Open

feat(docs): add i18n support with Chinese translations#31
OS-Lihua wants to merge 2 commits intohyperlane-xyz:mainfrom
OS-Lihua:main

Conversation

@OS-Lihua
Copy link

@OS-Lihua OS-Lihua commented Oct 6, 2025

1289c8a3b6bc1fa594375c9467576817 f0099658a7acb162ed64faf9a528f6aa
  • Add zh/ directory structure for Chinese documentation
  • Translate core protocol, guides, and reference docs
  • Enable bilingual documentation support

Summary by CodeRabbit

  • New Features

    • Multi-language documentation navigation (English and Chinese) with reorganized, deeper hierarchies.
    • Enhanced SEO and social metadata for better indexing and previews.
    • Tabbed views for chain latency tables (Mainnet/Testnet) to improve readability.
  • Documentation

    • Large expansion of Chinese docs: Warp Routes (overview, types, guides), Interchain Accounts (overview, usage, overrides), operator/relayer setup and APIs, protocol overviews, ISM (modular, multisig, routing, off-chain lookup), and protocol economics.
    • Added comprehensive reference tables for deployments and validators.
    • Updated internal links to absolute paths and refined glossary wording.

@coderabbitai
Copy link

coderabbitai bot commented Oct 6, 2025

📝 Walkthrough

Walkthrough

Major docs overhaul: navigation shifted to per-language blocks with extensive Chinese additions across protocol, applications, guides, operate, and reference sections. Added many new pages, large address tables, ISM docs, relayer API docs, and production guides. Minor English link fixes. One content refactor replaces a component with tabbed tables.

Changes

Cohort / File(s) Summary
Navigation & SEO structure
docs.json
Replaced navigation.tabs with navigation.languages; added parallel en/zh trees; expanded groups/pages; added seo.indexing and richer metatags.
ISM docs (ZH) & flows
zh/docs/protocol/ISM/*
Added modular security overview, marketplace, sequence diagram, aggregation/multisig/offchain-lookup/routing ISMs, economic security overview and AVS docs, multisig latency tables.
Interchain Accounts (ZH)
zh/docs/applications/interchain-account/*
Added overview, example usage, and overrides docs including API signatures and usage patterns.
Warp Routes docs (ZH)
zh/docs/applications/warp-routes/*, zh/docs/protocol/warp-routes/*
Added overview, types, example usage, interface snippet, multi-collateral v2, and assorted EVM/SVM guides.
Guides: Chains & Production (ZH)
zh/docs/guides/chains/*, zh/docs/guides/production/*
Added deployment guides (new chain, local agents), production ops (update default ISM, transfer ownership), Squads usage, and troubleshooting.
Operate: Agents, Relayer API, Validators (ZH)
zh/docs/operate/*, zh/docs/operate/relayer/api/*, zh/docs/operate/validators/*
Added agent overview, relayer run/config, message filtering, monitoring, HTTP API endpoints (messages, operations, merkle insertions, IGP), validator run/monitoring/signatures, Docker/Terraform quickstarts, AVS operator guide.
Reference: Addresses (ZH)
zh/docs/reference/addresses/deployments/*, zh/docs/reference/addresses/validators/*
Added extensive Mainnet/Testnet address tables for core contracts and validator configs/latencies.
Protocol Core (ZH)
zh/docs/protocol/core/*, zh/docs/protocol/protocol-overview.mdx, zh/docs/protocol-economics/intro.mdx
Added mailbox, fees, interchain gas payment, protocol overview, and protocol economics introduction.
Alt VM (ZH + minor EN fix)
zh/docs/alt-vm-implementations/*, docs/alt-vm-implementations/overview.mdx
Added Cosmos SDK overview/guide and multi-VM overview in ZH; fixed EN link to Cosmos SDK page.
Quickstarts & Bridge UI (ZH + EN link fixes)
zh/docs/guides/quickstart/*, zh/docs/guides/warp-routes/bridge-ui-guide.mdx, docs/guides/quickstart/deploy-warp-route.mdx
Added ZH quickstarts (local testnet, warp deploy) and Bridge UI guide; updated EN links to absolute paths.
English content refactors
docs/protocol/ISM/standard-ISMs/multisig-ism-latencies.mdx, docs/protocol/core/interchain-gas-payment.mdx, docs/resources/glossary.mdx, docs/guides/warp-routes/evm/transfer-and-call-pattern.mdx
Replaced ChainList with tabbed tables; updated internal links to absolute paths.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Sender
  participant Mailbox (Origin)
  participant Relayer
  participant ISM
  participant Mailbox (Dest)
  participant Recipient

  Sender->>Mailbox (Origin): dispatch(message, hookMetadata)
  Note over Mailbox (Origin): Message enqueued, root updated
  Relayer-->>Mailbox (Origin): fetch checkpoint/metadata
  Relayer->>Mailbox (Dest): process(metadata, message)
  Mailbox (Dest)->>ISM: verify(metadata, message)
  alt verified
    ISM-->>Mailbox (Dest): true
    Mailbox (Dest)->>Recipient: handle(message)
  else failed
    ISM-->>Mailbox (Dest): false/revert
    Mailbox (Dest)-->>Relayer: reject
  end
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

Suggested reviewers

  • tkporter
  • kamiyaa

Poem

Swapped the paths, stacked the scrolls, tidy as a swamp can be,
Tabs for nets, links made straight, docs now roam both land and sea.
Relayers hum, ISMs nod, routes weave through every tree,
Builders grin, gas is paid—off we go, cross-chain and free.
Onion layers, but in docs. 🧅✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title concisely describes the primary change—enabling i18n support and adding Chinese translations to the documentation—which directly matches the extensive additions in the zh directory.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@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: 31

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
zh/docs/guides/quickstart/deploy-warp-route.mdx (1)

159-163: Fix the internal Warp Route links.

These references drop the leading slash and language prefix, so the reader hits a dead end. Point them at the localized path to keep navigation smooth.

-- 查看 [HWR](docs/applications/warp-routes/overview) 参考页面,了解有关 HWR 接口和安全影响的更多信息。[接口](docs/applications/warp-routes/overview#interface)部分涵盖调用 `transferRemote` 将代币转移到目标链上的指定接收者。请注意,在调用 `transferRemote` 之前,您必须提示进行代币批准。
+- 查看 [HWR](/zh/docs/applications/warp-routes/overview) 参考页面,了解有关 HWR 接口和安全影响的更多信息。[接口](/zh/docs/applications/warp-routes/overview#interface)部分涵盖调用 `transferRemote` 将代币转移到目标链上的指定接收者。请注意,在调用 `transferRemote` 之前,您必须提示进行代币批准。
🧹 Nitpick comments (9)
zh/docs/guides/warp-routes/evm/fast-native-transfer-via-gas-token.mdx (1)

74-94: Swap the code fence language

That config block is YAML, but the fence says solidity, which throws off highlighting and smells funny.

-   ```solidity
+   ```yaml
zh/docs/protocol/ISM/standard-ISMs/aggregation-ISM.mdx (1)

38-43: Trim the deja vu in the Aggregation ISM section.

These two sentences repeat the overview from earlier, so the page loops back on itself. Dropping the duplicate copy keeps the doc lean and a bit easier to read.

zh/docs/guides/warp-routes/evm/xerc20-warp-route.mdx (1)

45-49: Tidy up the adapter-contract emphasis

This sentence renders odd because the escaped asterisks show up literally. Swap them for a normal bold pair so the adapter list reads cleanly.

-这部署了 \*Hyperlane 适配器合约\*\*,即:
+这部署了 **Hyperlane 适配器合约**,即:
zh/docs/operate/guides/avs-operator-guide.mdx (1)

7-12: Point local links at the zh docs

Since the Chinese mailbox page now exists, it’s nicer to link to /zh/docs/protocol/core/mailbox so readers stay in the localized flow. Same idea for any other newly translated targets.

zh/docs/operate/set-up-agent-keys.mdx (1)

23-34: Use a placeholder private key

文档里塞了真实格式的私钥示例,像现在这样很容易继续触发密钥扫描警报。改成明显的占位符(比如 0xABC…)就不会再惹怒安全工具了。

-    Address: 0x32e6d32E7b1C8691Ef4ad3841003371214a0eebC
-    Private Key: 0x2958f0eb2ab71bbfb5ea1422835e20e488778b61e3c107f369572e2b53b578f9
+    Address: 0xYourGeneratedAddress
+    Private Key: 0xyourgeneratedprivatekey
zh/docs/guides/warp-routes/evm/deploy-multi-collateral-warp-routes.mdx (1)

8-10: Keep folks inside the locale trails

这一段把读者从中文路线上带回英文 /docs/...,体验像踩了偏门小路。换成 /zh/docs/applications/warp-routes/multi-collateral-warp-routes 就能让导航保持在同一片林地。

zh/docs/applications/use-cases/cross-chain-swaps-with-recovery.mdx (1)

5-43: Keep the links on the same language track

这里的内部链接还指向英文 /docs/...,中文读者点进去会忽然出国。把这些路径切到 /zh/docs/... 的对应页面,更贴合本地化体验,也方便未来维护。

zh/docs/guides/warp-routes/evm/extending-warp-routes.mdx (1)

112-121: 把 Gnosis Safe 代码块排好

现在三引号跟正文挤在一行里,MDX 会把整段当普通文字,示例读不出来。把说明和 ```yaml 分开放行,并把 YAML 排版好些,读者才不会迷路。

-  <TabItem value="gnosis">
-    使用此模板定义并保存 Gnosis Safe 策略:```yaml
-    basesepolia: submitter: type: "gnosisSafe" chain: "basesepolia" safeAddress:
-    "0x518489F9ed41Fc35BCD23407C484F31897067ff0" sepolia: submitter: type:
-    "gnosisSafe" chain: "sepolia" safeAddress:
-    "0x518489F9ed41Fc35BCD23407C484F31897067ff0" holesky: submitter: type:
-    "gnosisSafe" chain: "holesky" safeAddress:
-    "0x1f9090aaE28b8a3dCeaDf281B0F12828e676c326" ``` 在这种情况下,每个链都是
+  <TabItem value="gnosis">
+    使用此模板定义并保存 Gnosis Safe 策略:
+
+```yaml
+basesepolia:
+  submitter:
+    type: "gnosisSafe"
+    chain: "basesepolia"
+    safeAddress: "0x518489F9ed41Fc35BCD23407C484F31897067ff0"
+sepolia:
+  submitter:
+    type: "gnosisSafe"
+    chain: "sepolia"
+    safeAddress: "0x518489F9ed41Fc35BCD23407C484F31897067ff0"
+holesky:
+  submitter:
+    type: "gnosisSafe"
+    chain: "holesky"
+    safeAddress: "0x1f9090aaE28b8a3dCeaDf281B0F12828e676c326"
+```
+
+    在这种情况下,每个链都是
zh/docs/protocol/warp-routes/warp-routes-overview.mdx (1)

17-18: 把链接指向中文版本

这儿引用的是 /docs/protocol/ISM/modular-security,直接把读者带回英文站。既然我们有中文页面,就把链接改成 /zh/docs/protocol/ISM/modular-security(或用相对路径)吧,这样阅读体验才顺滑。

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e2a64d and c25cb2c.

📒 Files selected for processing (99)
  • docs.json (2 hunks)
  • docs/guides/production/warp-route-deployment/transfer-warp-route-ownership.mdx (1 hunks)
  • docs/protocol/ISM/standard-ISMs/multisig-ism-latencies.mdx (1 hunks)
  • zh/docs/alt-vm-implementations/cosmos-sdk.mdx (1 hunks)
  • zh/docs/alt-vm-implementations/implementation-guide.mdx (1 hunks)
  • zh/docs/alt-vm-implementations/overview.mdx (1 hunks)
  • zh/docs/applications/interchain-account/example-usage.mdx (1 hunks)
  • zh/docs/applications/interchain-account/overrides.mdx (1 hunks)
  • zh/docs/applications/interchain-account/overview.mdx (1 hunks)
  • zh/docs/applications/use-cases/cross-chain-swaps-with-recovery.mdx (1 hunks)
  • zh/docs/applications/use-cases/cross-chain-swaps.mdx (1 hunks)
  • zh/docs/applications/warp-routes/example-usage.mdx (1 hunks)
  • zh/docs/applications/warp-routes/interface.mdx (1 hunks)
  • zh/docs/applications/warp-routes/multi-collateral-warp-routes.mdx (1 hunks)
  • zh/docs/applications/warp-routes/overview.mdx (1 hunks)
  • zh/docs/applications/warp-routes/types.mdx (1 hunks)
  • zh/docs/get-started-building.mdx (1 hunks)
  • zh/docs/guides/chains/deploy-hyperlane-with-local-agents.mdx (1 hunks)
  • zh/docs/guides/chains/deploy-hyperlane.mdx (1 hunks)
  • zh/docs/guides/create-custom-hook-and-ism.mdx (1 hunks)
  • zh/docs/guides/deploy-hyperlane-troubleshooting.mdx (1 hunks)
  • zh/docs/guides/production/core-deployment/transfer-mailbox-ownership.mdx (1 hunks)
  • zh/docs/guides/production/core-deployment/update-mailbox-default-ism.mdx (1 hunks)
  • zh/docs/guides/production/prod-overview.mdx (1 hunks)
  • zh/docs/guides/production/using-squads/alt-svm-using-sqauds.mdx (1 hunks)
  • zh/docs/guides/production/using-squads/using-squads-solana.mdx (1 hunks)
  • zh/docs/guides/production/warp-route-deployment/remove-trusted-relayer.mdx (1 hunks)
  • zh/docs/guides/production/warp-route-deployment/transfer-warp-route-ownership.mdx (1 hunks)
  • zh/docs/guides/quickstart/deploy-warp-route.mdx (1 hunks)
  • zh/docs/guides/quickstart/local-testnet-setup.mdx (1 hunks)
  • zh/docs/guides/warp-routes/bridge-ui-guide.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm-svm-warp-route-guide.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/deploy-multi-collateral-warp-routes.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/deploy-yield-routes.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/extending-warp-routes.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/fast-native-transfer-via-gas-token.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/managing-warp-route-limits.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/multi-collateral-warp-routes-rebalancing.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/transfer-and-call-pattern.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/xerc20-warp-route.mdx (1 hunks)
  • zh/docs/guides/warp-routes/svm/svm-warp-route-guide.mdx (1 hunks)
  • zh/docs/intro.mdx (1 hunks)
  • zh/docs/operate/config/agent-config.mdx (1 hunks)
  • zh/docs/operate/config/config-reference.mdx (1 hunks)
  • zh/docs/operate/guides/avs-operator-guide.mdx (1 hunks)
  • zh/docs/operate/guides/deploy-with-terraform.mdx (1 hunks)
  • zh/docs/operate/guides/docker-quickstart.mdx (1 hunks)
  • zh/docs/operate/overview-agents.mdx (1 hunks)
  • zh/docs/operate/relayer/api.mdx (1 hunks)
  • zh/docs/operate/relayer/api/igp/delete-igp-rules.mdx (1 hunks)
  • zh/docs/operate/relayer/api/igp/get-igp-rules.mdx (1 hunks)
  • zh/docs/operate/relayer/api/igp/post-igp-rules.mdx (1 hunks)
  • zh/docs/operate/relayer/api/merkle-tree-insertions/get-merkle-tree-insertions.mdx (1 hunks)
  • zh/docs/operate/relayer/api/merkle-tree-insertions/post-merkle-tree-insertions.mdx (1 hunks)
  • zh/docs/operate/relayer/api/messages/get-messages.mdx (1 hunks)
  • zh/docs/operate/relayer/api/messages/post-messages.mdx (1 hunks)
  • zh/docs/operate/relayer/api/operations/get-operations.mdx (1 hunks)
  • zh/docs/operate/relayer/api/operations/post-message-retry.mdx (1 hunks)
  • zh/docs/operate/relayer/api/operations/post-reprocess-message.mdx (1 hunks)
  • zh/docs/operate/relayer/message-filtering.mdx (1 hunks)
  • zh/docs/operate/relayer/monitoring-alerting.mdx (1 hunks)
  • zh/docs/operate/relayer/run-relayer.mdx (1 hunks)
  • zh/docs/operate/set-up-agent-keys.mdx (1 hunks)
  • zh/docs/operate/validators/monitoring-alerting.mdx (1 hunks)
  • zh/docs/operate/validators/run-validators.mdx (1 hunks)
  • zh/docs/operate/validators/validator-signatures-aws.mdx (1 hunks)
  • zh/docs/protocol-economics/intro.mdx (1 hunks)
  • zh/docs/protocol/ISM/custom-ISM.mdx (1 hunks)
  • zh/docs/protocol/ISM/economic-security/hyperlane-avs.mdx (1 hunks)
  • zh/docs/protocol/ISM/economic-security/overview.mdx (1 hunks)
  • zh/docs/protocol/ISM/ism-marketplace.mdx (1 hunks)
  • zh/docs/protocol/ISM/modular-security.mdx (1 hunks)
  • zh/docs/protocol/ISM/sequence-diagram.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/aggregation-ISM.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/multisig-ISM.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/multisig-ism-latencies.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/offchain-lookup-ISM.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/routing-ISM.mdx (1 hunks)
  • zh/docs/protocol/agents/overview.mdx (1 hunks)
  • zh/docs/protocol/agents/relayer.mdx (1 hunks)
  • zh/docs/protocol/agents/validators.mdx (1 hunks)
  • zh/docs/protocol/core/fees.mdx (1 hunks)
  • zh/docs/protocol/core/interchain-gas-payment.mdx (1 hunks)
  • zh/docs/protocol/core/mailbox.mdx (1 hunks)
  • zh/docs/protocol/core/post-dispatch-hooks-overview.mdx (1 hunks)
  • zh/docs/protocol/protocol-overview.mdx (1 hunks)
  • zh/docs/protocol/warp-routes/warp-routes-example-usage.mdx (1 hunks)
  • zh/docs/protocol/warp-routes/warp-routes-overview.mdx (1 hunks)
  • zh/docs/protocol/warp-routes/warp-routes-types.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/interchainAccountRouter.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/interchainGasPaymaster.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/mailbox.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/merkleTreeHook.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/proxyAdmin.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/storageGasOracle.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/testRecipient.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/validatorAnnounce.mdx (1 hunks)
  • zh/docs/reference/addresses/validators/latencies.mdx (1 hunks)
  • zh/docs/reference/addresses/validators/mainnet-default-ism-validators.mdx (1 hunks)
🧰 Additional context used
🪛 Gitleaks (8.28.0)
zh/docs/operate/config/config-reference.mdx

[high] 396-396: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 409-409: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 877-877: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 884-884: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 1140-1140: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 1147-1147: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

zh/docs/operate/set-up-agent-keys.mdx

[high] 32-32: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (1)
docs.json (1)

185-204: Fix double slash in Agent Keys path

导航里写成 "docs/operate//set-up-agent-keys",多了个 / 会让生成的链接报 404,同样的问题在中文块的 "zh/docs/operate//set-up-agent-keys"。把多余的斜杠砍掉,大家才能顺利到达钥匙教程。

-                "pages": ["docs/operate//set-up-agent-keys"]
+                "pages": ["docs/operate/set-up-agent-keys"]
...
-                "pages": ["zh/docs/operate//set-up-agent-keys"]
+                "pages": ["zh/docs/operate/set-up-agent-keys"]

Likely an incorrect or invalid review comment.

- Add zh/ directory structure for Chinese documentation
- Translate core protocol, guides, and reference docs
- Enable bilingual documentation support
Copy link

@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: 8

♻️ Duplicate comments (9)
zh/docs/applications/interchain-account/overrides.mdx (1)

23-47: Close the Solidity fence, friend.

That code block never gets its closing ``` so the rest of the page stays fenced. Drop the terminator right after the final function signature to tame the layout.

     function getRemoteInterchainAccount(
         address _owner,
         address _router,
         address _ism
     ) public view returns (address)
+```
zh/docs/operate/relayer/api/messages/get-messages.mdx (1)

23-71: Document the messages envelope and fix the Python example

Docs still promise a裸 HyperlaneMessage[] response, yet real clients (and your own JS snippet) unwrap a top-level messages. The schema and the Python sample both tell the wrong tale, so anyone copying them will stumble. Please put the messages field on the response schema and update the Python example to extract response.json()["messages"].

Apply this diff to sort it:

-<Expandable title="响应正文">
-  <ResponseField type="HyperlaneMessage[]">
-    HyperlaneMessage 对象数组
-  </ResponseField>
+<Expandable title="响应正文">
+  <ResponseField name="messages" type="HyperlaneMessage[]">
+    HyperlaneMessage 对象数组
+  </ResponseField>
@@
-response = requests.get('http://localhost:9090/messages', params={
-    'domain_id': 1,
-    'nonce_start': 100,
-    'nonce_end': 200
-})
-messages = response.json()
+response = requests.get('http://localhost:9090/messages', params={
+    'domain_id': 1,
+    'nonce_start': 100,
+    'nonce_end': 200
+})
+messages = response.json()["messages"]
zh/docs/guides/quickstart/local-testnet-setup.mdx (1)

76-84: Restore the YAML layers

These metadata examples are mashed into single lines, which makes them painful to copy and breaks the real metadata.yaml layout. Let’s lay each key on its own line and indent the nested bits so folks can drop the snippet straight into their configs.

 - **anvilnode1**
 

-chainId: 31337displayName: Anvilnode1domainId: 31337isTestnet: truename: anvilnode1nativeToken: decimals: 18 name: ETH symbol: ETHprotocol: ethereumrpcUrls: - http: http://localhost:8545
+chainId: 31337
+displayName: Anvilnode1
+domainId: 31337
+isTestnet: true
+name: anvilnode1
+nativeToken:


- **anvilnode2**

-chainId: 31338displayName: Anvilnode2domainId: 31338isTestnet: truename: anvilnode2nativeToken: decimals: 18 name: ETH symbol: ETHprotocol: ethereumrpcUrls: - http: http://localhost:8546
+chainId: 31338
+displayName: Anvilnode2
+domainId: 31338
+isTestnet: true
+name: anvilnode2
+nativeToken:


</blockquote></details>
<details>
<summary>zh/docs/guides/warp-routes/bridge-ui-guide.mdx (1)</summary><blockquote>

`7-8`: **Patch up the heading anchors.**

The quick links at the top still point to `#fork--customize-the-ui` and `#superbridge`, but the headings render with number-prefixed slugs, so the jumps fall flat. Drop explicit IDs onto the two section headers to keep the in-page links working.

```diff
-## 1. Hyperlane Warp UI 模板
+## 1. Hyperlane Warp UI 模板 {#fork--customize-the-ui}
@@
-## 2. Superbridge
+## 2. Superbridge {#superbridge}

Also applies to: 10-10, 113-113

zh/docs/operate/validators/run-validators.mdx (2)

238-239: Build command drops required --bin.

cargo build --release bin validator won't ever spit out the binary; Cargo expects --bin validator. Drop the ogre-sized typo so folks actually get a build.

-cargo build --release bin validator
+cargo build --release --bin validator

303-304: Missing separator before <region_name>.

The flag and value are mushed together. Slide in a space (or =) so the CLI sees the region.

---chains.<your_chain_name>.signer.region<region_name>
+--chains.<your_chain_name>.signer.region <region_name>
zh/docs/operate/config/config-reference.mdx (1)

392-414: Swap in unmistakable placeholders for the sample key.

The 64‑char hex string keeps tripping leak scanners and looks too real for comfort. Replace every instance with something obvious like <YOUR_PRIVATE_KEY_HEX> so folks don’t copy swampy secrets by accident.

zh/docs/protocol/agents/overview.mdx (1)

9-10: Fix the multisig link slug.

The path segment still uses multisig-ISM; on a case-sensitive host that 404s. Drop it to /multisig-ism so readers land in the right lair.

zh/docs/protocol/ISM/custom-ISM.mdx (1)

39-44: Restore the normal Solidity docblock.

那段注释还是逃逸成 /*\*\* 加前缀下划线,贴进合约就直接挂了。改回标准 /** ... */,每行用 * 打头,保持语义不变。

-interface InterchainSecurityModule {
-/** 
-_ @notice 返回表示此 ISM 编码的安全模型类型的枚举。
-_ @dev Relayer 推断如何获取和格式化 metadata。
-_/ 
-function moduleType() external view returns (uint8);
+interface InterchainSecurityModule {
+    /**
+     * @notice 返回表示此 ISM 编码的安全模型类型的枚举。
+     * @dev Relayer 推断如何获取和格式化 metadata。
+     */
+    function moduleType() external view returns (uint8);

(请对同片段里的其余函数注释也套用相同格式。)

🧹 Nitpick comments (3)
zh/docs/protocol/ISM/economic-security/overview.mdx (1)

10-11: Add the Optimistic ISM link for symmetry

Right now我们提到 Optimistic ISM 却没给条路走,读者得自己摸黑穿过沼泽。给它加上指向中文版文档的链接能让导航顺畅得多,和多签那一段保持一致。路径若不同,再按实际调整就好。

-质押和罚没允许将经济安全添加到依赖 Validator 签名的 ISM,包括[多重签名 ISM](/zh/docs/protocol/ISM/standard-ISMs/multisig-ISM) 和 Optimistic ISM。
+质押和罚没允许将经济安全添加到依赖 Validator 签名的 ISM,包括[多重签名 ISM](/zh/docs/protocol/ISM/standard-ISMs/multisig-ISM) 和 [Optimistic ISM](/zh/docs/protocol/ISM/standard-ISMs/optimistic-ISM)。
zh/docs/guides/warp-routes/evm/transfer-and-call-pattern.mdx (1)

107-109: Split the Info block bullets cleanly

Right now那 Info 块把好几条提醒挤在同一行,Markdown 只会认出第一条,其它三条就像陷进泥里一样看不清。把它们拆成独立的列表项,让读者一眼看懂风险点。

 <Info>
-  - **执行顺序考虑**:合约必须确保代币转账完全完成后才执行任何后续操作。如果远程调用依赖于代币余额(例如,质押、治理、存款),如果在代币到达之前执行,可能会失败。relayer (中继器) 会使用退避重试以确保成功的 ICA 调用执行。 - ICA 在执行存款之前可能还需要执行 ERC20 批准调用。 - 如果执行操作的合约没有权限限制,任何人都可以调用它(取决于其实现)。
+  - **执行顺序考虑**:合约必须确保代币转账完全完成后才执行任何后续操作。如果远程调用依赖于代币余额(例如,质押、治理、存款),如果在代币到达之前执行,可能会失败。
+  - relayer(中继器)会使用退避重试以确保成功的 ICA 调用执行。
+  - ICA 在执行存款之前可能还需要执行 ERC20 批准调用。
+  - 如果执行操作的合约没有权限限制,任何人都可以调用它(取决于其实现)。
 </Info>
zh/docs/reference/addresses/validators/latencies.mdx (1)

11-204: Align the tab UI with the Chinese copy.

Tabs and column headers still read “Mainnet/Testnet” and “Chain/Domain…”. Swapping those labels for “主网/测试网” and Chinese column headers will make the localized page feel finished.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c25cb2c and 0c80f42.

📒 Files selected for processing (104)
  • docs.json (2 hunks)
  • docs/alt-vm-implementations/overview.mdx (1 hunks)
  • docs/guides/production/warp-route-deployment/transfer-warp-route-ownership.mdx (1 hunks)
  • docs/guides/quickstart/deploy-warp-route.mdx (1 hunks)
  • docs/guides/warp-routes/evm/transfer-and-call-pattern.mdx (2 hunks)
  • docs/protocol/ISM/standard-ISMs/multisig-ism-latencies.mdx (1 hunks)
  • docs/protocol/core/interchain-gas-payment.mdx (2 hunks)
  • docs/resources/glossary.mdx (2 hunks)
  • zh/docs/alt-vm-implementations/cosmos-sdk.mdx (1 hunks)
  • zh/docs/alt-vm-implementations/implementation-guide.mdx (1 hunks)
  • zh/docs/alt-vm-implementations/overview.mdx (1 hunks)
  • zh/docs/applications/interchain-account/example-usage.mdx (1 hunks)
  • zh/docs/applications/interchain-account/overrides.mdx (1 hunks)
  • zh/docs/applications/interchain-account/overview.mdx (1 hunks)
  • zh/docs/applications/use-cases/cross-chain-swaps-with-recovery.mdx (1 hunks)
  • zh/docs/applications/use-cases/cross-chain-swaps.mdx (1 hunks)
  • zh/docs/applications/warp-routes/example-usage.mdx (1 hunks)
  • zh/docs/applications/warp-routes/interface.mdx (1 hunks)
  • zh/docs/applications/warp-routes/multi-collateral-warp-routes.mdx (1 hunks)
  • zh/docs/applications/warp-routes/overview.mdx (1 hunks)
  • zh/docs/applications/warp-routes/types.mdx (1 hunks)
  • zh/docs/get-started-building.mdx (1 hunks)
  • zh/docs/guides/chains/deploy-hyperlane-with-local-agents.mdx (1 hunks)
  • zh/docs/guides/chains/deploy-hyperlane.mdx (1 hunks)
  • zh/docs/guides/create-custom-hook-and-ism.mdx (1 hunks)
  • zh/docs/guides/deploy-hyperlane-troubleshooting.mdx (1 hunks)
  • zh/docs/guides/production/core-deployment/transfer-mailbox-ownership.mdx (1 hunks)
  • zh/docs/guides/production/core-deployment/update-mailbox-default-ism.mdx (1 hunks)
  • zh/docs/guides/production/prod-overview.mdx (1 hunks)
  • zh/docs/guides/production/using-squads/alt-svm-using-sqauds.mdx (1 hunks)
  • zh/docs/guides/production/using-squads/using-squads-solana.mdx (1 hunks)
  • zh/docs/guides/production/warp-route-deployment/remove-trusted-relayer.mdx (1 hunks)
  • zh/docs/guides/production/warp-route-deployment/transfer-warp-route-ownership.mdx (1 hunks)
  • zh/docs/guides/quickstart/deploy-warp-route.mdx (1 hunks)
  • zh/docs/guides/quickstart/local-testnet-setup.mdx (1 hunks)
  • zh/docs/guides/warp-routes/bridge-ui-guide.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm-svm-warp-route-guide.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/deploy-multi-collateral-warp-routes.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/deploy-yield-routes.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/extending-warp-routes.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/fast-native-transfer-via-gas-token.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/managing-warp-route-limits.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/multi-collateral-warp-routes-rebalancing.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/transfer-and-call-pattern.mdx (1 hunks)
  • zh/docs/guides/warp-routes/evm/xerc20-warp-route.mdx (1 hunks)
  • zh/docs/guides/warp-routes/svm/svm-warp-route-guide.mdx (1 hunks)
  • zh/docs/intro.mdx (1 hunks)
  • zh/docs/operate/config/agent-config.mdx (1 hunks)
  • zh/docs/operate/config/config-reference.mdx (1 hunks)
  • zh/docs/operate/guides/avs-operator-guide.mdx (1 hunks)
  • zh/docs/operate/guides/deploy-with-terraform.mdx (1 hunks)
  • zh/docs/operate/guides/docker-quickstart.mdx (1 hunks)
  • zh/docs/operate/overview-agents.mdx (1 hunks)
  • zh/docs/operate/relayer/api.mdx (1 hunks)
  • zh/docs/operate/relayer/api/igp/delete-igp-rules.mdx (1 hunks)
  • zh/docs/operate/relayer/api/igp/get-igp-rules.mdx (1 hunks)
  • zh/docs/operate/relayer/api/igp/post-igp-rules.mdx (1 hunks)
  • zh/docs/operate/relayer/api/merkle-tree-insertions/get-merkle-tree-insertions.mdx (1 hunks)
  • zh/docs/operate/relayer/api/merkle-tree-insertions/post-merkle-tree-insertions.mdx (1 hunks)
  • zh/docs/operate/relayer/api/messages/get-messages.mdx (1 hunks)
  • zh/docs/operate/relayer/api/messages/post-messages.mdx (1 hunks)
  • zh/docs/operate/relayer/api/operations/get-operations.mdx (1 hunks)
  • zh/docs/operate/relayer/api/operations/post-message-retry.mdx (1 hunks)
  • zh/docs/operate/relayer/api/operations/post-reprocess-message.mdx (1 hunks)
  • zh/docs/operate/relayer/message-filtering.mdx (1 hunks)
  • zh/docs/operate/relayer/monitoring-alerting.mdx (1 hunks)
  • zh/docs/operate/relayer/run-relayer.mdx (1 hunks)
  • zh/docs/operate/set-up-agent-keys.mdx (1 hunks)
  • zh/docs/operate/validators/monitoring-alerting.mdx (1 hunks)
  • zh/docs/operate/validators/run-validators.mdx (1 hunks)
  • zh/docs/operate/validators/validator-signatures-aws.mdx (1 hunks)
  • zh/docs/protocol-economics/intro.mdx (1 hunks)
  • zh/docs/protocol/ISM/custom-ISM.mdx (1 hunks)
  • zh/docs/protocol/ISM/economic-security/hyperlane-avs.mdx (1 hunks)
  • zh/docs/protocol/ISM/economic-security/overview.mdx (1 hunks)
  • zh/docs/protocol/ISM/ism-marketplace.mdx (1 hunks)
  • zh/docs/protocol/ISM/modular-security.mdx (1 hunks)
  • zh/docs/protocol/ISM/sequence-diagram.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/aggregation-ISM.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/multisig-ISM.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/multisig-ism-latencies.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/offchain-lookup-ISM.mdx (1 hunks)
  • zh/docs/protocol/ISM/standard-ISMs/routing-ISM.mdx (1 hunks)
  • zh/docs/protocol/agents/overview.mdx (1 hunks)
  • zh/docs/protocol/agents/relayer.mdx (1 hunks)
  • zh/docs/protocol/agents/validators.mdx (1 hunks)
  • zh/docs/protocol/core/fees.mdx (1 hunks)
  • zh/docs/protocol/core/interchain-gas-payment.mdx (1 hunks)
  • zh/docs/protocol/core/mailbox.mdx (1 hunks)
  • zh/docs/protocol/core/post-dispatch-hooks-overview.mdx (1 hunks)
  • zh/docs/protocol/protocol-overview.mdx (1 hunks)
  • zh/docs/protocol/warp-routes/warp-routes-example-usage.mdx (1 hunks)
  • zh/docs/protocol/warp-routes/warp-routes-overview.mdx (1 hunks)
  • zh/docs/protocol/warp-routes/warp-routes-types.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/interchainAccountRouter.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/interchainGasPaymaster.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/mailbox.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/merkleTreeHook.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/proxyAdmin.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/storageGasOracle.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/testRecipient.mdx (1 hunks)
  • zh/docs/reference/addresses/deployments/validatorAnnounce.mdx (1 hunks)
  • zh/docs/reference/addresses/validators/latencies.mdx (1 hunks)
  • zh/docs/reference/addresses/validators/mainnet-default-ism-validators.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (12)
  • docs/guides/warp-routes/evm/transfer-and-call-pattern.mdx
  • zh/docs/operate/relayer/api/igp/get-igp-rules.mdx
  • zh/docs/guides/production/using-squads/using-squads-solana.mdx
  • zh/docs/reference/addresses/deployments/proxyAdmin.mdx
  • zh/docs/operate/validators/validator-signatures-aws.mdx
  • zh/docs/reference/addresses/validators/mainnet-default-ism-validators.mdx
  • zh/docs/guides/production/core-deployment/update-mailbox-default-ism.mdx
  • zh/docs/protocol/warp-routes/warp-routes-types.mdx
  • zh/docs/protocol/core/mailbox.mdx
  • zh/docs/operate/relayer/api/operations/get-operations.mdx
  • zh/docs/protocol/warp-routes/warp-routes-example-usage.mdx
  • zh/docs/guides/warp-routes/evm/fast-native-transfer-via-gas-token.mdx
🚧 Files skipped from review as they are similar to previous changes (46)
  • zh/docs/protocol/protocol-overview.mdx
  • zh/docs/operate/relayer/api/merkle-tree-insertions/get-merkle-tree-insertions.mdx
  • zh/docs/operate/relayer/message-filtering.mdx
  • zh/docs/operate/relayer/run-relayer.mdx
  • zh/docs/operate/guides/docker-quickstart.mdx
  • zh/docs/applications/warp-routes/multi-collateral-warp-routes.mdx
  • zh/docs/applications/warp-routes/example-usage.mdx
  • zh/docs/operate/relayer/api/igp/post-igp-rules.mdx
  • zh/docs/alt-vm-implementations/implementation-guide.mdx
  • zh/docs/operate/relayer/api/merkle-tree-insertions/post-merkle-tree-insertions.mdx
  • zh/docs/operate/relayer/api.mdx
  • zh/docs/protocol/ISM/standard-ISMs/multisig-ism-latencies.mdx
  • zh/docs/reference/addresses/deployments/mailbox.mdx
  • zh/docs/reference/addresses/deployments/merkleTreeHook.mdx
  • zh/docs/protocol/ISM/standard-ISMs/aggregation-ISM.mdx
  • zh/docs/protocol/core/interchain-gas-payment.mdx
  • zh/docs/protocol/ISM/ism-marketplace.mdx
  • zh/docs/operate/relayer/api/messages/post-messages.mdx
  • zh/docs/protocol/ISM/economic-security/hyperlane-avs.mdx
  • zh/docs/protocol/core/fees.mdx
  • zh/docs/intro.mdx
  • zh/docs/applications/interchain-account/example-usage.mdx
  • zh/docs/guides/quickstart/deploy-warp-route.mdx
  • zh/docs/operate/relayer/api/operations/post-message-retry.mdx
  • zh/docs/guides/warp-routes/evm/extending-warp-routes.mdx
  • zh/docs/applications/interchain-account/overview.mdx
  • zh/docs/guides/create-custom-hook-and-ism.mdx
  • zh/docs/guides/warp-routes/svm/svm-warp-route-guide.mdx
  • zh/docs/protocol/agents/relayer.mdx
  • zh/docs/guides/production/prod-overview.mdx
  • zh/docs/reference/addresses/deployments/storageGasOracle.mdx
  • zh/docs/protocol/ISM/standard-ISMs/routing-ISM.mdx
  • zh/docs/operate/config/agent-config.mdx
  • zh/docs/protocol/ISM/modular-security.mdx
  • zh/docs/operate/relayer/api/igp/delete-igp-rules.mdx
  • zh/docs/applications/warp-routes/types.mdx
  • zh/docs/guides/warp-routes/evm/managing-warp-route-limits.mdx
  • zh/docs/guides/warp-routes/evm/deploy-multi-collateral-warp-routes.mdx
  • zh/docs/protocol-economics/intro.mdx
  • zh/docs/operate/validators/monitoring-alerting.mdx
  • zh/docs/protocol/ISM/standard-ISMs/offchain-lookup-ISM.mdx
  • zh/docs/guides/chains/deploy-hyperlane-with-local-agents.mdx
  • zh/docs/guides/chains/deploy-hyperlane.mdx
  • zh/docs/guides/warp-routes/evm/xerc20-warp-route.mdx
  • zh/docs/protocol/ISM/standard-ISMs/multisig-ISM.mdx
  • zh/docs/operate/relayer/monitoring-alerting.mdx
🧰 Additional context used
🪛 Gitleaks (8.28.0)
zh/docs/guides/warp-routes/evm-svm-warp-route-guide.mdx

[high] 78-78: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 119-119: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

zh/docs/operate/set-up-agent-keys.mdx

[high] 32-32: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

zh/docs/operate/config/config-reference.mdx

[high] 396-396: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 409-409: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 877-877: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 884-884: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 1140-1140: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)


[high] 1147-1147: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (2)
docs/guides/quickstart/deploy-warp-route.mdx (1)

164-164: Solid link adjustment

Switching to the root-anchored path keeps this guide in step with the new navigation scheme. No ogre-worthy concerns here.

zh/docs/guides/warp-routes/evm/multi-collateral-warp-routes-rebalancing.mdx (1)

21-38: Rebalancer rundown lands perfectly

Flows and role description line up with what we expect in the field, and the translation keeps it clear as a breezy walk through the marsh. Nicely done.

Copy link

@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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c80f42 and 038f62c.

📒 Files selected for processing (1)
  • docs.json (2 hunks)

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