protocolbuffers / protocolbuffers/protocolbuffers.github.io
ProtoJSON Format doc page does not describe how to generate JSON
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 69
- Forks
- 179
- PR merge metrics
- No merged PRs in 30d
Description
The documentation page: https://protobuf.dev/programming-guides/json/
The page sub-heading states that the page "Covers how to use the Protobuf to JSON conversion utilities." However, there is no information on how to generate a JSON file. The page only discusses caveats and edge cases regarding the JSON conversion.
I would like to see a section or link to a section that gives instructions on how use protoc or any other tool to actually create the JSON.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the ProtoJSON page at https://protobuf.dev/programming-guides/json/ and review its current coverage of conversion utilities, caveats, and edge cases. Add a section or link explaining how to generate a JSON file with protoc or another relevant tool, and confirm the page now covers the usage promised by its sub-heading.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100