Skip to content

Add Chinese README and move documentation to doc/ directory#23

Merged
cto-new[bot] merged 1 commit into
mainfrom
feat/docs/add-cn-readme-move-docs-to-doc-dir
Nov 4, 2025
Merged

Add Chinese README and move documentation to doc/ directory#23
cto-new[bot] merged 1 commit into
mainfrom
feat/docs/add-cn-readme-move-docs-to-doc-dir

Conversation

@cto-new

@cto-new cto-new Bot commented Nov 4, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR adds a complete Chinese version of the README and reorganizes all documentation files into a dedicated doc/ directory for better structure and accessibility.

Details

  • Added a full Chinese translation of the README as README.zh-CN.md with language switcher links.
  • Moved all documentation files (except README.md and README.zh-CN.md) from the project root into the doc/ folder.
  • Updated all internal documentation links in markdown files to use the new doc/ path or relative links as appropriate.
  • Revised DOCS_INDEX.md to reflect new file locations and to include the Chinese README.
  • Added DOCUMENTATION_REORGANIZATION.md to summarize the changes and provide migration notes.
  • Verified references and made minor fixes for cross-link correctness throughout the docs.
  • This is a BREAKING CHANGE for anyone referencing documentation by its old path.

This change improves project accessibility for Chinese-speaking users and
modernizes documentation organization. Added README.zh-CN.md with a full
translation of the English README. Moved all documentation files, except
README.md and README.zh-CN.md, to a new doc/ folder. Updated all internal
documentation links in markdown files to reflect the new structure and added
documentation reorganization notes. This improves discoverability, reduces
clutter in the project root, and ensures easy access to all docs in both
languages.

BREAKING CHANGE: All documentation files (except READMEs) are now located in doc/.
Update any scripts, references, or links accordingly.
@cto-new cto-new Bot merged commit 93ed946 into main Nov 4, 2025
4 checks passed
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.

0 participants