docs: docgen proto with protoc-gen-doc
#557
Open
+501
−0
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.
fixes #555
utilizes https://github.com/pseudomuto/protoc-gen-doc
to generate the needed docs ready to upload to the homepage.
Note
did not setup a proper template, yet - since the new website is not public :D
But the template has been foreseen, it is expected to go into the folder
docgen/proto/template
.See template docs here: https://github.com/pseudomuto/protoc-gen-doc/wiki/Custom-Templates
CI run: https://github.com/CycloneDX/specification/actions/runs/12536710058/job/34960006706
CI result: https://github.com/CycloneDX/specification/actions/runs/12536710058/artifacts/2369477602
structure: