docs: update READMEs with protobuf protocol links and refactor visualizer docs#869
Merged
Conversation
…izer docs - Add "Protobuf Protocols" section to README.md, README_CN.md, and README_JA.md linking to protocol details. - Rewrite `utils/protobuf_visualizer/README.md` in English: - Simplify usage instructions and command-line flags. - Rename tool description to "eCapture Protobuf Debugger". - Remove verbose legacy documentation.
dosubot
Bot
added
the
size:XL
zenyanle
changed the title
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation by adding comprehensive Protobuf protocol documentation and refactoring the visualizer tool documentation. It adds new "Protobuf Protocols" sections to all main README files (English, Chinese, Japanese) with links to detailed protocol specifications, creates new compilation guides for Protobuf code generation, introduces detailed protocol overview documents explaining the message structures, and rewrites the protobuf visualizer README in a more concise format while adding a Chinese version.
Key Changes
- Added "Protobuf Protocols" sections linking to
protobuf/PROTOCOLS.md(and localized versions) in README.md, README_CN.md, and README_JA.md - Created new documentation files:
protobuf/README.md,protobuf/README_CN.md,protobuf/PROTOCOLS.md, andprotobuf/PROTOCOLS_CN.md - Simplified and rewrote
utils/protobuf_visualizer/README.mdin English, renaming the tool to "eCapture Protobuf Debugger" and created a Chinese version
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds Protobuf Protocols section with link to protocol documentation |
| README_CN.md | Adds Chinese Protobuf Protocols section with link to Chinese protocol documentation |
| README_JA.md | Adds Japanese Protobuf Protocols section with link to English protocol documentation |
| utils/protobuf_visualizer/README.md | Complete rewrite: simplified from 267 lines to 41 lines with cleaner usage instructions |
| utils/protobuf_visualizer/README_CN.md | New Chinese documentation for the protobuf debugger tool |
| protobuf/README.md | New compilation guide explaining how to regenerate Go code from protobuf definitions |
| protobuf/README_CN.md | Chinese version of the compilation guide |
| protobuf/PROTOCOLS.md | New comprehensive protocol documentation explaining message structures (LogType, Event, Heartbeat, LogEntry) with integration examples |
| protobuf/PROTOCOLS_CN.md | Chinese version of the protocol documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
utils/protobuf_visualizer/README.mdin English: