[PR #1153] [MERGED] [doc]merge doc to docs，and change all internal links to blog. #2041

New issue

Closed

opened 2026-10-29 21:32:19 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented 2026-10-29 21:32:19 +00:00

Owner

Copy link

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/Mooncake/pull/1153
Author: @Keithwwa
Created: 12/2/2025
Status: ✅ Merged
Merged: 12/15/2025
Merged by: @ykwd

Base: main ← Head: pr_merge_doc_to_docs_1202

---

📝 Commits (2)

• c65c362 merge doc/en/ to docs/
• a4fa479 move chinese documents to an archive directory

📊 Changes

45 files changed (+92 additions, -2476 deletions)

View changed files

📝 README.md (+11 -11)
➖ doc/en/architecture.md (+0 -20)
➖ doc/en/build.md (+0 -167)
➖ doc/en/error-code.md (+0 -65)
➖ doc/en/lmcache-integration.md (+0 -59)
➖ doc/en/lmcacheV1-deployment.md (+0 -134)
➖ doc/en/lmdeploy-integration-v0.9.md (+0 -167)
➖ doc/en/p2p-store.md (+0 -99)
➖ doc/en/sglang-benchmark-results-v1.md (+0 -26)
➖ doc/en/sglang-hicache-benchmark-results-v1.md (+0 -181)
➖ doc/en/sglang-integration-v1.md (+0 -132)
➖ doc/en/transfer-engine-python.md (+0 -431)
➖ doc/en/troubleshooting.md (+0 -107)
➖ doc/en/vllm-benchmark-results-v0.2.md (+0 -49)
➖ doc/en/vllm-benchmark-results-v1.md (+0 -22)
➖ doc/en/vllm-integration-v0.2.md (+0 -191)
➖ doc/en/vllm-integration-v1.md (+0 -167)
📝 docs/source/design/ep-backend.md (+0 -0)
📝 docs/source/design/mooncake-store.md (+29 -0)
➖ docs/source/design/transfer-engine.md (+0 -435)

...and 25 more files

📄 Description

…ct to blog

Description

Motivation:

• Regarding the issues#1060 mentioned earlier, the content and responsibilities of the doc and docs documents overlap, making the cost of maintaining both sets of content higher.

Solution:

• Merge doc/en into docs, remove duplicates, and categorize new content, and change all internal links redirect to blog.

Changes:

• Place doc/en/ascend_direct_transport.md, doc/en/ascend_transport.md, doc/en/heterogeneous_ascend.md and doc/en/ transfer-engine-bench-tuning.md in the Design document/Transfer Engine directory
• Place doc/en/Mooncake EP in the Design document directory.
• Add the content newly added in doc/en but not yet included in docs to docs, including: build.md、transfer_engine.md、mooncake_store.md、troubleshotting.md.
• Move doc/zh to docs/source/zh_archive, and add README.md for this dir.
• Delete all others.
• Change all internal links redirect to blog，side from NIXL, because it doesn't provide an document website.

Type of Change

• Types
  • Bug fix
  • New feature
    • Transfer Engine
    • Mooncake Store
    • Mooncake EP
    • Integration
    • P2P Store
    • Python Wheel
  • Breaking change
  • CI/CD
  • Documentation update
  • Other

How Has This Been Tested?

the Design Documents after changed:

Checklist

• I have performed a self-review of my own code.
• I have updated the documentation.
• I have added tests to prove my changes are effective.

---

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/kvcache-ai/Mooncake/pull/1153 **Author:** [@Keithwwa](https://github.com/Keithwwa) **Created:** 12/2/2025 **Status:** ✅ Merged **Merged:** 12/15/2025 **Merged by:** [@ykwd](https://github.com/ykwd) **Base:** `main` ← **Head:** `pr_merge_doc_to_docs_1202` --- ### 📝 Commits (2) - [`c65c362`](https://github.com/kvcache-ai/Mooncake/commit/c65c3620b00a0bc7a8f93b7bd5d4fa0791c96953) merge doc/en/ to docs/ - [`a4fa479`](https://github.com/kvcache-ai/Mooncake/commit/a4fa47901279c9ecf9b369a6d4b2f8d885c0f746) move chinese documents to an archive directory ### 📊 Changes **45 files changed** (+92 additions, -2476 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+11 -11) ➖ `doc/en/architecture.md` (+0 -20) ➖ `doc/en/build.md` (+0 -167) ➖ `doc/en/error-code.md` (+0 -65) ➖ `doc/en/lmcache-integration.md` (+0 -59) ➖ `doc/en/lmcacheV1-deployment.md` (+0 -134) ➖ `doc/en/lmdeploy-integration-v0.9.md` (+0 -167) ➖ `doc/en/p2p-store.md` (+0 -99) ➖ `doc/en/sglang-benchmark-results-v1.md` (+0 -26) ➖ `doc/en/sglang-hicache-benchmark-results-v1.md` (+0 -181) ➖ `doc/en/sglang-integration-v1.md` (+0 -132) ➖ `doc/en/transfer-engine-python.md` (+0 -431) ➖ `doc/en/troubleshooting.md` (+0 -107) ➖ `doc/en/vllm-benchmark-results-v0.2.md` (+0 -49) ➖ `doc/en/vllm-benchmark-results-v1.md` (+0 -22) ➖ `doc/en/vllm-integration-v0.2.md` (+0 -191) ➖ `doc/en/vllm-integration-v1.md` (+0 -167) 📝 `docs/source/design/ep-backend.md` (+0 -0) 📝 `docs/source/design/mooncake-store.md` (+29 -0) ➖ `docs/source/design/transfer-engine.md` (+0 -435) _...and 25 more files_ </details> ### 📄 Description …ct to blog ## Description Motivation: - Regarding the [issues#1060](https://github.com/kvcache-ai/Mooncake/issues/1060) mentioned earlier, the content and responsibilities of the doc and docs documents overlap, making the cost of maintaining both sets of content higher. Solution: - Merge doc/en into docs, remove duplicates, and categorize new content, and change all internal links redirect to blog. Changes: - Place `doc/en/ascend_direct_transport.md`, `doc/en/ascend_transport.md`, `doc/en/heterogeneous_ascend.md` and `doc/en/ transfer-engine-bench-tuning.md` in the `Design document/Transfer Engine` directory - Place `doc/en/Mooncake EP` in the `Design document` directory. - Add the content newly added in `doc/en` but not yet included in `docs` to `docs`, including: `build.md`、`transfer_engine.md`、`mooncake_store.md`、`troubleshotting.md`. - Move `doc/zh` to `docs/source/zh_archive`, and add `README.md` for this dir. - Delete all others. - Change all internal links redirect to blog，side from NIXL, because it doesn't provide an document website. ## Type of Change * Types - [ ] Bug fix - [ ] New feature - [ ] Transfer Engine - [ ] Mooncake Store - [ ] Mooncake EP - [ ] Integration - [ ] P2P Store - [ ] Python Wheel - [ ] Breaking change - [ ] CI/CD - [x] Documentation update - [ ] Other ## How Has This Been Tested? the Design Documents after changed: <img width="1156" height="661" alt="image" src="https://github.com/user-attachments/assets/c55d79a8-f095-40b6-bcb0-bd25ca8acadd" /> ## Checklist - [x] I have performed a self-review of my own code. - [x] I have updated the documentation. - [ ] I have added tests to prove my changes are effective. --- _{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

bsakaguchi 2026-10-29 21:32:19 +00:00

• closed this issue
• added the
  pull-request
  label

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

te-coro

staryxchen-tent-capability-research

feature/musa-ep-jit

zxpdemonio/fix-tent-bootstrap-admission

add-store-rs-tone-tests

scatter-rdma-completion-pr2

P2P-Mooncake-Store

release/v0.3.14

feat/tent-rdma-adaptive-adapter

fix/ep-local-counter-gpu-scope

codex/kvcs-oplog-eviction

give-me-a-star

cruz/mooncake-kvcs-lowlevel-pr1-20261008

ylt-handshake-limits

ci/rocm-e2e-tent

sima/docs-pypi-downloads

fix-ci/hicache-mooncake-metadata-loopback

sima/cuda-driver-loading

sima/ci-performance-gate

fix/tent-rdma-unknown-topology-rail-pairing

ci/tent-e2e-dual-job

mc-patch-1

codex/p2p-merge-prerequisites

sima/store-hca-numa-placement

codex/p2p-merge-cli

codex/p2p-merge-ipv6

copilot/fix-ctests-job-failure

czh/pg-device-collectives-pr6

dependabot/cargo/mooncake-store-rs/pyo3-0.29.0

czh/pg-device-collectives-pr5

codex/segment-pool-master-cutover

sima/nightly-ci-recovery

ci/tent-params

stmatengss-patch-1

dependabot/cargo/mooncake-store-rs/rand-0.8.8

dependabot/cargo/mooncake-store-rs/opentelemetry_sdk-0.32.1

dependabot/cargo/mooncake-store-rs/xxhash-rust-0.8.16

codex/migrate-store-rest-service

fix/tone-wheel-arch-selection

czh/pg-device-collectives-pr4

czh/pg-device-collectives-pr3

ketong/fix_moe_tc

copilot/fix-test-wheel-ubuntu-job

fix/ci-wheel-torch-pg-pin

codex/migrate-structured-object-storage

codex/migrate-allocator-python

codex/migrate-vllm-python

codex/migrate-shared-segment

ci/fix_sgl_eval_install

codex/segment-pool-nof-placement-cleanup

feat/pip-native-release

copilot/bugfix-ha-standby-promotion

copilot/mooncake-store-transport-settings

copilot/fix-tensor-support-issues

copilot/optimize-rl-direction

copilot/mooncake-storeagentic-workflow

copilot/fix-client-reconnect-timeout

copilot/mooncake-error-debugging

copilot/mooncake-ipv6-support

feat/nccl-host-python-api

dependabot/go_modules/mooncake-p2p-store/src/p2pstore/google.golang.org/grpc-1.82.1

copilot/migrate-and-move-operations

copilot/migrate-and-move-operations-again

refactor/centralize-env-vars

idhanani/mooncake-retain-groups

copilot/codeownerreviewer

copilot/give-feedback-on-issue-2123

copilot/create-issue-rfc

copilot/break-cuda-monopoly-logic

copilot/compare-cudamemcpy-cu12-cu13

copilot/report-ci-error-issue

copilot/research-commit-history-analysis

copilot/explain-mooncake-store-service

copilot/analyze-project-functionality

copilot/sub-pr-1680

copilot/review-pr-1680

copilot/sub-pr-1597

copilot/fix-github-actions-job-failure

copilot/move-test-sglang-integration-job

v0.3.14

v0.3.14-pre-4

v0.3.14-pre-3

v0.3.14-pre-2

v0.3.14-pre

v0.3.14-rc1

v0.3.13.post1

v0.3.13-rc2

v0.3.13-rc1

v0.3.13

v0.3.12.post1

v0.3.12

v0.3.11-rc1

v0.3.11.post1

v0.3.11

v0.3.10.post2

v0.3.10.post1

v0.3.10

v0.3.9

v0.3.8.post1

v0.3.8

v0.3.7.post2

v0.3.7.post1

v0.3.7

v0.3.6.post1

v0.3.6

v0.3.5

v0.3.4.post2

v0.3.4.post1

v0.3.4

v0.3.3.post2

v0.3.3.post1

v0.3.3

v0.3.2.post1

v0.3.2

v0.3.1

v0.3.0

v0.3.0-beta

v0.3.0-alpha

v0.2.0

Labels

Clear labels   

ascend

  

auto-closed

  

bug

  

bug

  

CI/Build

  

Common

  

documentation

  

enhancement

  

feature request

  

good first issue

  

help wanted

  

high priority

  

MetaX

  

nightly-failure

  

pull-request

Mirrored from GitHub Pull Request

  

PyTorch Backend

  

question

  

RFC

  

Roadmap

  

stale

  

Store

  

Tests

  

Transfer Engine

No labels

ascend

auto-closed

bug

bug

CI/Build

Common

documentation

enhancement

feature request

good first issue

help wanted

high priority

MetaX

nightly-failure

pull-request

PyTorch Backend

question

RFC

Roadmap

stale

Store

Tests

Transfer Engine

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

kvcache-ai/Mooncake#2041

No description provided.