Skip to content

docs: add Simplified Chinese translation (README.zh.md) - #2143

Closed
JasonYeYuhe wants to merge 1 commit into
fastapi:mainfrom
jasonye-oss:docs/add-zh-readme
Closed

JasonYeYuhe wants to merge 1 commit into
fastapi:mainfrom
jasonye-oss:docs/add-zh-readme

Conversation

@JasonYeYuhe

Copy link
Copy Markdown

Summary

This PR introduces a comprehensive Simplified Chinese translation of the project documentation (README.zh.md) and adds bidirectional language switchers.

Highlights

  • Full Documentation Parity: Covers core SQLModel philosophy, seamless synergy with FastAPI, underlying unification of Pydantic and SQLAlchemy, full example walk-throughs (table definition, instance records, engine & session management, queries), and complete IDE editor support demonstrations.
  • PyPI Packaging Safe: The language switcher in README.md uses an absolute GitHub URL to preserve link integrity when published to PyPI (pyproject.toml).
  • Idiomatic Technical Tone & DCO Compliant: Strict authoritative tone without first-person colloquialisms, zero trailing whitespaces, and signed off with DCO.

- Add comprehensive Simplified Chinese documentation covering core features, FastAPI integration, model definitions, session management, and editor support.
- Add language switcher in README.md with PyPI-safe absolute URL and relative link in README.zh.md.

Signed-off-by: YE <yyyyy.yeyuhe@gmail.com>
Copilot AI balanced review requested due to automatic review settings November 18, 2026 14:59

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-18T15:02:36.622070Z a396c8a PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

Copy link
Copy Markdown
Contributor

📝 Docs preview

Last commit a396c8a at: https://cc204282.sqlmodel.pages.dev

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a396c8a6ca

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +8 to +10
<p align="center">
<a href="https://github.com/fastapi/sqlmodel/blob/main/README.zh.md"><b>简体中文</b></a> | <b>English</b>
</p>

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Add the language switcher to the README generation source

On the next change to docs/index.md or scripts/docs.py, the generate-readme hook in .pre-commit-config.yaml:59-64 will overwrite README.md using generate_readme_content(). Because docs/index.md was not updated, the generated header still matches the pre-change README and removes this switcher, losing the English-to-Chinese entry point. Add the switcher to the generation source as well so ordinary documentation updates preserve it.

Useful? React with 👍 / 👎.

@YuriiMotov

Copy link
Copy Markdown
Member

Thanks for your interest and efforts, but please follow the rules of the repository.

We ask people to only open PRs when it's explicitly requested by maintainers.
See https://tiangolo.com/open-source/contributing/ and PR description template:

Please start with a GitHub Discussion.

Once a team member asks you to open a PR, create it and link the discussion here.

I will close this for now to keep things clean.
Thanks for understanding!

@YuriiMotov YuriiMotov closed this Nov 18, 2026
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