Repository navigation
docs: add Simplified Chinese translation (README.zh.md) - #2143
JasonYeYuhe wants to merge 1 commit into
Conversation
- 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>
There was a problem hiding this comment.
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.
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
📝 Docs previewLast commit a396c8a at: https://cc204282.sqlmodel.pages.dev |
There was a problem hiding this comment.
💡 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".
| <p align="center"> | ||
| <a href="https://github.com/fastapi/sqlmodel/blob/main/README.zh.md"><b>简体中文</b></a> | <b>English</b> | ||
| </p> |
There was a problem hiding this comment.
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 👍 / 👎.
|
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.
I will close this for now to keep things clean. |
Summary
This PR introduces a comprehensive Simplified Chinese translation of the project documentation (
README.zh.md) and adds bidirectional language switchers.Highlights
README.mduses an absolute GitHub URL to preserve link integrity when published to PyPI (pyproject.toml).