-
Notifications
You must be signed in to change notification settings - Fork 1.6k
refactor: rename Chinese documentation files and update links in README #927
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: CFC4N <[email protected]>
|
🔧 Debug Build Complete (PR #927) 📦 Download Links: ⏰ Files will be retained for 7 days, please download and test promptly. This build includes debug binaries for: android/linux (arm64/amd64) |
✅ E2E Test Results: PASSEDTest Run: #21541488509 Tests Executed:
✅ All e2e tests passed successfully! The TLS capture functionality is working correctly. Automated e2e test results for commit b86065e |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR standardizes Chinese documentation naming conventions by migrating from inconsistent -CN or _CN suffixes to the more standardized -zh_Hans suffix (representing Simplified Chinese using Hans script). The changes also include removing the Japanese README file, updating internal documentation links, and minor URL updates in example outputs.
Changes:
- Renamed and updated all Chinese documentation files to use
-zh_Hanssuffix instead of-CNor_CN - Removed Japanese README (README_JA.md) and DeepWiki badge
- Updated example output URLs from
https://ecapture.cctohttps://v2.ecapture.cc - Modified terminology from "中文" to "汉字" throughout Chinese documentation
Reviewed changes
Copilot reviewed 7 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| protobuf/README-zh_Hans.md | New Chinese version of protobuf compilation guide using standardized naming |
| protobuf/PROTOCOLS-zh_Hans.md | New Chinese version of protobuf protocol documentation |
| docs/remote-config-update-api-zh_Hans.md | New Chinese version of remote config API documentation |
| docs/event-forward-api-zh_Hans.md | New Chinese version of event forwarding API documentation |
| docs/compilation-zh_Hans.md | New Chinese version of compilation guide |
| functions.mk | Updated build script to copy renamed Chinese README file |
| examples/ecaptureq_client/TESTING.md | Updated homepage URL in example output to v2 subdomain |
| examples/ecaptureq_client/README.md | Updated homepage URL in example output to v2 subdomain |
| docs/README.md | Updated links to Chinese documentation files with new naming convention |
| README_JA.md | Deleted Japanese README file |
| README.md | Removed DeepWiki badge and Japanese link, updated Chinese link |
| README-zh_Hans.md | Updated terminology and internal documentation links |
Comments suppressed due to low confidence (2)
README-zh_Hans.md:3
- There are extra spaces around "汉字" in the language selector. This should be
汉字 | [English](./README.md)without the leading space to maintain consistent formatting.
README-zh_Hans.md:41 - The terminology change from "中文名字" to "汉字名字" is linguistically unusual. "汉字" specifically refers to Chinese characters (the writing system), not the Chinese language itself. The standard term would be "中文名字" or "中文名称" (Chinese name). This change appears to be attempting consistency with the "汉字" label used in the language selector, but that label itself is unconventional for indicating "Simplified Chinese" - the standard would be "简体中文" or "中文".
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
[skip-ci] Signed-off-by: CFC4N <[email protected]>
✅ E2E Test Results: PASSEDTest Run: #21541819341 Tests Executed:
✅ All e2e tests passed successfully! The TLS capture functionality is working correctly. Automated e2e test results for commit 624bd7f |
This pull request focuses on improving language consistency and documentation structure for Chinese language resources, as well as making minor updates to documentation links and references. The most significant changes involve renaming files and links from older naming conventions (e.g.,
-CNor_CN) to a more standardized-zh_Hanssuffix, and updating references throughout the documentation to match. There are also minor updates to URLs and removal of some badges.Documentation and Language Standardization:
README_CN.mdtoREADME-zh_Hans.md, and updated all references and links to use the new filename and the term "汉字" for consistency. [1] [2] [3]docs/README.md,README-zh_Hans.md) to use the new-zh_Hanssuffix for all Chinese documentation (e.g.,compilation-zh_Hans.md,event-forward-api-zh_Hans.md,remote-config-update-api-zh_Hans.md,PROTOCOLS-zh_Hans.md). [1] [2] [3] [4] [5]Content and Branding Updates:
https://ecapture.cctohttps://v2.ecapture.ccinexamples/ecaptureq_client/README.mdandexamples/ecaptureq_client/TESTING.md. [1] [2]Content Clarification:
File Maintenance:
functions.mkto copy the renamed Chinese README (README-zh_Hans.md) instead of the old filename.These changes help standardize documentation for Chinese users, improve clarity, and ensure all resources use consistent naming conventions across the project.