Skip to content

Conversation

@cfc4n
Copy link
Member

@cfc4n cfc4n commented Jan 31, 2026

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., -CN or _CN) to a more standardized -zh_Hans suffix, and updating references throughout the documentation to match. There are also minor updates to URLs and removal of some badges.

Documentation and Language Standardization:

  • Renamed the main Simplified Chinese README from README_CN.md to README-zh_Hans.md, and updated all references and links to use the new filename and the term "汉字" for consistency. [1] [2] [3]
  • Updated links in documentation files (docs/README.md, README-zh_Hans.md) to use the new -zh_Hans suffix 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:

  • Updated the homepage URL in example output logs from https://ecapture.cc to https://v2.ecapture.cc in examples/ecaptureq_client/README.md and examples/ecaptureq_client/TESTING.md. [1] [2]
  • Removed the DeepWiki badge and cleaned up language selector lines in the English and Chinese README files. [1] [2]

Content Clarification:

  • Updated some wording in the Chinese README for clarity, such as replacing "中文名字" with "汉字名字" to match the new terminology.

File Maintenance:

  • Updated the release build script in functions.mk to 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.

Copilot AI review requested due to automatic review settings January 31, 2026 08:10
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jan 31, 2026
@dosubot
Copy link

dosubot bot commented Jan 31, 2026

Related Documentation

Checked 1 published document(s) in 1 knowledge base(s). No updates required.

How did I do? Any feedback?  Join Discord

@github-actions
Copy link

🔧 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)

@github-actions
Copy link

✅ E2E Test Results: PASSED

Test Run: #21541488509

Tests Executed:

  • TLS/OpenSSL Module (curl → github.com)
  • GnuTLS Module (wget/curl → github.com)
  • GoTLS Module (Go client → github.com)

✅ All e2e tests passed successfully! The TLS capture functionality is working correctly.


Automated e2e test results for commit b86065e

Copy link

Copilot AI left a 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_Hans suffix instead of -CN or _CN
  • Removed Japanese README (README_JA.md) and DeepWiki badge
  • Updated example output URLs from https://ecapture.cc to https://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.

@cfc4n cfc4n merged commit 348ccc8 into v2 Jan 31, 2026
7 of 9 checks passed
@cfc4n cfc4n deleted the feat/v2-readme-homepage branch January 31, 2026 08:39
@github-actions
Copy link

✅ E2E Test Results: PASSED

Test Run: #21541819341

Tests Executed:

  • TLS/OpenSSL Module (curl → github.com)
  • GnuTLS Module (wget/curl → github.com)
  • GoTLS Module (Go client → github.com)

✅ All e2e tests passed successfully! The TLS capture functionality is working correctly.


Automated e2e test results for commit 624bd7f

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants