Automated generation of handlers documentation #1173
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
qkaiser
force-pushed
the
handlers-doc
branch
2 times, most recently
from
a2c000f to
fe7f288
Compare
e3krisztian
reviewed
May 6, 2025
rasakozi
reviewed
May 7, 2025
|
Looks good to me! I think we can merge this and make some adjustments once I create a proper page in the docs. |
rasakozi
approved these changes
May 7, 2025
I'd just wait for @e3krisztian approval too, then we merge :) |
e3krisztian
reviewed
May 8, 2025
There was a problem hiding this comment.
I think we should revise the handler names for some formats to make the handler table more informative to people not knowing the formats by heart, it could be however in another PR.
Please take a look into why LZ4 is appearing 3 times - that looks strange/wrong.
qkaiser
force-pushed
the
handlers-doc
branch
2 times, most recently
from
e9eeac9 to
09310c6
Compare
e3krisztian
reviewed
May 9, 2025
e3krisztian
reviewed
May 9, 2025
We had to use --unsafe in check-yaml so that it checks syntax but does not attempt to load the YAML itself. Otherwise an error gets triggered by the emoji plugin of mkdocs.
e3krisztian
approved these changes
May 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Early draft for handler documentation.
It introduces a
HandlerDocclass that bothHandlerandDirectoryHandlerrequires under theDOCfield. This class takes a name, a handler type, a description, and a list of references.This is both useful for maintainers since the handlers will contain detailed information and references within the code (kinda like module info in Metasploit), and users as this is ultimately used to dynamically generate the documentation available on unblob.org
This is a very early draft. All the DOC fields were generated by copilot and must be reviewed. The markdown structure and what we do with the DOC content is still open to discussion.