Skip to content

docs: add Chinese documentation and restructure docs directory#928

Open
Tsan1024 wants to merge 2 commits into
Blaizzy:mainfrom
Tsan1024:main
Open

docs: add Chinese documentation and restructure docs directory#928
Tsan1024 wants to merge 2 commits into
Blaizzy:mainfrom
Tsan1024:main

Conversation

@Tsan1024
Copy link
Copy Markdown

@Tsan1024 Tsan1024 commented Apr 5, 2026

MR Description

Background

The project currently lacks a structured Chinese documentation, which makes it harder for Chinese-speaking developers to understand and adopt MLX-VLM.


Changes

This MR introduces Chinese documentation and reorganizes the existing docs structure:

  • Added README_CN.md as the Chinese introduction
  • Moved existing English documentation to docs/en/
  • Created a new docs/cn/ directory for Chinese documentation
  • Added corresponding Chinese docs

Motivation

  • Improve accessibility for Chinese-speaking users
  • Enhance documentation clarity and organization
  • Facilitate broader community adoption

Impact

  • No code changes
  • No impact on existing functionality
  • Documentation-only update

Notes

Further improvements may include:

  • Chinese quick start guide
  • FAQ section
  • More detailed bilingual documentation

Checklist

  • Documentation structure is clear
  • Changes are limited to docs only
  • No impact on existing features

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