跳到主要内容

English Documentation Chinese Cleanup Design

Scope

Scan all Markdown, MDX, and JSON files under docs/en/ and translate every remaining Chinese passage into English. This includes prose, headings, code comments, documentation comments, log strings, example strings, and explanatory text embedded in code blocks.

Translation rules

  • Use docs/en/glossary.md as the terminology authority.
  • Preserve API names, class names, method names, field names, enum values, paths, URLs, and other program identifiers.
  • Translate string values when they are human-readable examples or output.
  • Do not alter syntax or program behavior beyond translating human-readable text.
  • When a term or a behavior-sensitive string is ambiguous, pause for requester confirmation.

Validation

  • Rescan all relevant text files for Chinese characters.
  • Manually review any residual matches and classify only intentional identifiers, if any.
  • Inspect the diff for terminology consistency, code-fence integrity, and accidental non-translation changes.
  • Run the repository's available documentation validation or build command when discoverable.

Relationship to the original translation plan

This cleanup intentionally supersedes the earlier requirement that code blocks remain byte-for-byte unchanged. The requester has confirmed that all Chinese text in docs/en/, including code-block comments and strings, must be translated.