Skip to content

[docs] conductor docs#2970

Merged
Chase-Rong merged 1 commit into
kvcache-ai:dev/conductorfrom
Chase-Rong:docs
Jul 18, 2026
Merged

[docs] conductor docs#2970
Chase-Rong merged 1 commit into
kvcache-ai:dev/conductorfrom
Chase-Rong:docs

Conversation

@Chase-Rong

@Chase-Rong Chase-Rong commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Description

modify conductor docs

Module

  • Transfer Engine (mooncake-transfer-engine)
  • Mooncake Store (mooncake-store)
  • Mooncake EP (mooncake-ep)
  • Mooncake PG (mooncake-pg)
  • Integration (mooncake-integration)
  • P2P Store (mooncake-p2p-store)
  • Python Wheel (mooncake-wheel)
  • Common (mooncake-common)
  • Mooncake RL (mooncake-rl)
  • CI/CD
  • Docs
  • Other

Type of Change

  • Bug fix
  • New feature
  • Refactor
  • Breaking change
  • Documentation update
  • Performance improvement
  • Other

How Has This Been Tested?

Test commands:

# Example: bash scripts/run_ci_test.sh

Test results:

  • Unit tests pass
  • Integration tests pass (if applicable)
  • Manual testing done (describe below)

Checklist

  • I have performed a self-review of my own code
  • I have formatted my code using ./scripts/code_format.sh
  • I have run pre-commit run --all-files and all hooks pass
  • I have updated the documentation (if applicable)
  • I have added tests to prove my changes are effective
  • For changes >500 LOC: I have filed an RFC issue

AI Assistance Disclosure

  • No AI tools were used
  • AI tools were used (specify below)

@github-actions github-actions Bot added documentation Improvements or additions to documentation run-ci labels Jul 17, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request reorganizes and updates the documentation for Mooncake Conductor, including its architecture, HTTP API, usage, and KV events in both English and Chinese. The review feedback highlights a missing navigation link in the English index page and untranslated English paragraphs in the Chinese usage guide, both of which are addressed with actionable code suggestions.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +39 to +41
conductor-architecture-design
usage
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The English toctree list is missing the indexer-api-design reference, which is present in the Chinese version. This causes the HTTP API reference page to be omitted from the Conductor section navigation in English.

Suggested change
conductor-architecture-design
usage
```
conductor-architecture-design
usage
indexer-api-design

Comment on lines +252 to +261
查看缓存共享组合和已注册的推理 rank:

```bash
curl -sS http://127.0.0.1:13333/global_view
```

对应结果中出现 `"engine-a":[0,1]`,说明检查成功。Mooncake 不会作为另一个推理实例出现。收到实时事件后,`prefix_count` 可能增加,但仅凭这个计数无法判断每个块来自哪个缓存位置。

## 查询

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

These paragraphs in the Chinese documentation are untranslated and left in English. They should be translated to Chinese to ensure consistency and completeness.

Suggested change
查看缓存共享组合和已注册的推理 rank:
```bash
curl -sS http://127.0.0.1:13333/global_view
```
对应结果中出现 `"engine-a":[0,1]`,说明检查成功。Mooncake 不会作为另一个推理实例出现。收到实时事件后,`prefix_count` 可能增加,但仅凭这个计数无法判断每个块来自哪个缓存位置。
## 查询
Mooncake 订阅。在 /services 和 /global_view 中核对配置的种子和派生的根摘要。对于静态配置,订阅会并发启动,因此在两项检查都通过前,请保持产生缓存的流量暂停。
8. 允许缓存流量,确认 Mooncake 发布端计数增加,并查询一个已知的 token 前缀。共享的 CPU 或 Disk 计数必须出现在兼容的 vLLM 实例下,而不是 Mooncake 注册名称下。
[Conductor 使用指南](../conductor/usage.md)提供了完整的注册和查询命令。

@Chase-Rong
Chase-Rong merged commit ca17b97 into kvcache-ai:dev/conductor Jul 18, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation run-ci

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant