Skip to content

docs: add Chinese translation of README (README.zh-CN.md)#197

Closed
jnMetaCode wants to merge 1 commit into
abhigyanpatwari:mainfrom
jnMetaCode:docs/chinese-readme
Closed

docs: add Chinese translation of README (README.zh-CN.md)#197
jnMetaCode wants to merge 1 commit into
abhigyanpatwari:mainfrom
jnMetaCode:docs/chinese-readme

Conversation

@jnMetaCode

Copy link
Copy Markdown

Summary

Adds a complete Chinese translation of the project README as README.zh-CN.md, with a language switcher link at the top of the English README.

Related to #95 — this is the first step toward broader Chinese language support.

What's included

  • Full translation of all sections: features, CLI commands, MCP tools, architecture, examples, tech stack, roadmap
  • Code blocks, command examples, and technical identifiers kept in English
  • Mermaid diagrams translated (node labels and edge labels)
  • Language switcher: English | 中文 at the top of both READMEs

Why

GitNexus has growing interest from Chinese-speaking developers (ref #95). A translated README lowers the barrier to entry without affecting the existing codebase.

@vercel

vercel Bot commented Mar 6, 2026

Copy link
Copy Markdown

@jnMetaCode is attempting to deploy a commit to the NexusCore Team on Vercel.

A member of the Team first needs to authorize it.

Add README.zh-CN.md with full Chinese translation of the project
documentation, and add a language switcher link at the top of the
English README.

Ref abhigyanpatwari#95

@reversTeam reversTeam left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice contribution, @jnMetaCode! The translation is thorough and well-structured. Approving with a couple of minor notes:

What looks good:

  • Complete coverage of all README sections including CLI commands, MCP tools table, architecture diagram, examples, and tech stack.
  • Code blocks, file paths, and command examples are correctly left in English.
  • Mermaid diagram labels are translated, which is a nice touch for readability.
  • The language switcher (English | 中文) at the top of both READMEs is clean and non-intrusive.

Minor notes (non-blocking):

  • The scam warning paragraph at the top of the English README (⚠️ Important Notice...) does not appear to be translated in README.zh-CN.md. This might be intentional, but if Chinese-speaking users are a target audience, they would benefit from seeing that warning too.
  • Consider whether the Mermaid diagram node labels should stay in English for consistency with the codebase identifiers (e.g., RegFile, Server, Backend), since developers reading the Chinese docs will still interact with English code. This is a style choice though — either way works.

Great first step toward broader i18n support. Welcome!

@magyargergo

Copy link
Copy Markdown
Collaborator

⚠️ Upcoming Prettier formatting — rebase instructions

PR #563 adds Prettier as the code formatter for the repo. When it merges, the bulk format commit will touch ~350 files (style-only: whitespace, quotes, trailing commas). Your branch will likely conflict.

After #563 merges, rebase your branch:

git fetch origin
git checkout <your-branch>
git rebase origin/main

# Conflicts will be formatting-only — accept your version:
git checkout --theirs .
git add .
git rebase --continue

# Then re-format your branch to match the new style:
npx prettier --write .
git add -A
git commit -m "style: apply prettier formatting"
git push --force-with-lease

New setup step: Run npm install at the repo root (not just in gitnexus/) to get prettier + activate the pre-commit hook. The hook auto-formats staged files on every commit going forward.

@magyargergo

Copy link
Copy Markdown
Collaborator

Please submit a new PR if this is still relevant

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.

3 participants