Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE]: Generate a browsable documentation for the protobuf specification #555

Open
andreas-hilti opened this issue Dec 28, 2024 · 0 comments · May be fixed by #557
Open

[FEATURE]: Generate a browsable documentation for the protobuf specification #555

andreas-hilti opened this issue Dec 28, 2024 · 0 comments · May be fixed by #557

Comments

@andreas-hilti
Copy link
Contributor

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
Image
(This was only a quick first shot, you can also further customize it.)

Alternatives

The 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants