-
-
Notifications
You must be signed in to change notification settings - Fork 82
Closed
Description
Describe the feature
Generate a browsable documentation for the protobuf specification.
For JSON and XML, you already have a browsable documentation of the specification, i.e.
https://cyclonedx.org/docs/1.6/json/#
and
https://cyclonedx.org/docs/1.6/xml/
I think it would be valuable to have something similar also for the protobuf specification.
Possible solutions
You can use for instance https://github.com/pseudomuto/protoc-gen-doc.
Using
protoc.exe --doc_out=./docgen/proto --doc_opt=html,index.html schema/bom-1.6.proto
this generates:
index.zip

(This was only a quick first shot, you can also further customize it.)
Alternatives
There might be other documentation generators, but I don't know them.
An alternative is also to provide only the raw proto file (but this is not very attractive IMO).
Additional context
Reactions are currently unavailable