ProtoJSON Format doc page does not describe how to generate JSON

Open
#289 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
json
Domain
documentation

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.

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.

Dominant language
HTML
Stars
69
Forks
179
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from protocolbuffers/protocolbuffers.github.io

All issues in protocolbuffers/protocolbuffers.github.io

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.