Skip to content

[Doc📝] Chinese docs are out of sync with English docs (missing pages and unfinished sections) #6914

@WaterWhisperer

Description

@WaterWhisperer

Issue Type

Missing documentation

Location

The issue is in the Chinese docs tree for the website:
rocketmq-website/i18n/zh-CN/docusaurus-plugin-content-docs/current

English source docs for comparison:
rocketmq-website/docs

Description

Chinese documentation is currently not synchronized with English documentation in both structure and content.

Current findings from comparison:

  1. English docs have 31 pages while Chinese docs have 20 pages.
  2. 15 English pages are missing in Chinese.
  3. Some Chinese pages are still placeholder-level content.
  4. Some existing Chinese pages are significantly less complete than their English counterparts.

Suggested Fix

Proposed phased plan:

  1. Create the missing zh-CN pages with correct structure/frontmatter.
  2. Replace placeholder pages with real translated content.
  3. Expand shortened pages to match English scope (especially getting-started, consumer, producer, configuration, faq).
  4. Add a docs sync checklist for future updates to reduce drift.

Definition of done:

  1. No placeholder text remains in zh-CN docs.
  2. Core user-facing doc structure is aligned between English and Chinese.
  3. Each missing page has a corresponding zh-CN page.
  4. Key pages have practical parity with English (not exact line-by-line translation, but complete concepts and usage coverage).

Willing to contribute?

  • I can submit a PR for this

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions