PyO3 / PyO3/pyo3

Proposal: Add Simplified Chinese Translation for PyO3 Doc

Open
#5,282 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
16.2k
Forks
1k
Avg merge
2d 6h
Merged PRs (30d)
66

Description

🌍 Motivation

PyO3 has become an excellent bridge for Rust-Python interop, especially for performance-critical applications like ML extensions. In China, both Rust and Python communities are rapidly growing - RustCon Asia events draw huge crowds, and Python dominates in AI/data science fields.

However, the English-only documentation creates a barrier for many non-native speakers, limiting PyO3's adoption in the Chinese-speaking community. I've noticed strong demand in local forums (e.g., Rust China groups) for more accessible resources, and I believe Simplified Chinese localization could significantly boost usage and contributions from this region.

🎯 Proposal

I would like to contribute to PyO3 by providing Simplified Chinese translation of the documentation. This would be the first translation of PyO3 documentation, so we need to establish:

  1. Translation process and workflow
  2. Website structure to support multiple languages
  3. Quality assurance and review process
  4. Maintenance strategy for keeping translations up-to-date

👨‍💻 About Me

I'm Rafa, a Python developer from China with experience in Rust and familiarity with FastAPI. I've been following PyO3 closely as it's an excellent tool for Rust-Python interop, particularly for performance-critical applications.

🤔 Questions for Discussion

  1. Technical Implementation:

    • What's the preferred approach for implementing i18n on the PyO3 website?
    • Should we maintain the use of mdBook for the translated documentation?
    • How should we structure the repository to accommodate translations?
  2. Translation Strategy:

    • Should we start with core sections or translate comprehensively?
    • What's the preferred workflow for submitting translations (separate PRs, dedicated branch)?
    • How should we handle technical terms (translate vs. keep original with explanation & Glossary)?
  3. Quality Assurance:

    • What review process should we establish for translation quality?
  4. Maintenance:

    • How should we handle updates when the English documentation changes?
    • How do we handle version management for translations?

🚀 Next Steps

I'm excited to contribute to this effort and help make PyO3 more accessible to the Chinese-speaking community. I'm looking forward to:

  1. Getting feedback from the community on this proposal
  2. Establishing the technical framework for translations
  3. Beginning work on the Chinese translation
  4. Building a sustainable process for future translations

📝 Additional Notes

This could serve as a foundation for other language translations in the future. The process we establish for Chinese could be replicated for other languages requested by the community.
I'm eager to contribute to this effort and would be happy to help in whatever way the community thinks would be most valuable.


Looking forward to your thoughts and guidance on how to move forward! 🎉

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The proposal names no files, tests, or entry points. First confirm the preferred website and documentation structure, translation workflow, review process, and maintenance strategy with maintainers; done would mean an agreed, sustainable approach for Simplified Chinese localization.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
documentation, internationalization, localization
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.