lulianqi opened a new issue, #12: URL: https://github.com/apache/dubbo-net/issues/12
## Background The current `README.md` is primarily written in Chinese. As the project's default landing page, it should also be readily accessible to the wider Apache Dubbo and international .NET community, while retaining complete Chinese documentation. ## Proposal - Make `README.md` the **English** documentation and the default repository/NuGet README. - Add `readme_cn.md` containing the complete **Simplified Chinese** documentation. - Add clear language-switch links at the top of both files, using relative paths. Suggested language navigation: English `README.md`: ```markdown **English** | [简体中文](readme_cn.md) ``` Chinese `readme_cn.md`: ```markdown [English](README.md) | **简体中文** ``` Use the exact filename `readme_cn.md` and matching link case, so the links work on case-sensitive platforms. ## Scope 1. Preserve and move/adapt the existing Chinese documentation into `readme_cn.md`; do not remove information simply to shorten the English version. 2. Provide a complete, natural English `README.md`, including introduction, installation, quick start, feature usage, compatibility matrix, limitations, testing and contribution information. 3. Keep the two versions consistent on capabilities, framework requirements, API examples, configuration defaults, security limitations and licensing/provenance statements. This documentation task must not silently change supported behavior or claim unverified compatibility. 4. Preserve code identifiers, package names, CLI options and Java signatures; translate the surrounding explanations. 5. Check relative document/image links, table-of-contents anchors and references elsewhere in the repository that point to renamed/translated README headings. 6. Keep `PackageReadmeFile` pointing to `README.md`, so the package's default README is also English. No package publishing or runtime-code changes are required by this issue. 7. Keep `LICENSE` and `NOTICE` unchanged; preserve their references in both README versions. ## Acceptance criteria - [ ] GitHub displays the English `README.md` by default. - [ ] `readme_cn.md` exists and retains the complete Chinese documentation. - [ ] Both files have visible, working English/简体中文 language links at the top. - [ ] Installation, examples, compatibility claims and important limitations agree between the two versions. - [ ] Relative links, images, navigation anchors and affected in-repository references work. - [ ] NuGet packaging still selects the English `README.md`. - [ ] No public API, runtime behavior, LICENSE or NOTICE changes are introduced as part of the translation. ## Maintenance When documentation changes are made in future PRs, update both language versions together, or explicitly identify any temporarily untranslated sections to avoid the two versions drifting apart. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
