Cookbook documentation on creating structures via API #5929
Labels
Component: Documentation
Issue needs changes to our documentation
Effort: Trivial
Issue should take < 1 day
Impact: Low
Issue is a papercut or has a good, supported workaround
Type: Enhancement
Issue is a small enhancement to existing functionality
Milestone
I wasted too much time trying to figure out how to create a new custom type via API. ChatGPT was actually somewhat helpful. I like cookbook section of docs, lots of good common recipes.
zznop pointed somone to this bit of source for creating a structure with structure builder and it was very helpful.
https://github.com/zznop/bnida/blob/master/binja/binja_import.py#L150
Also, a bunch of the scripting mechanics I use all the time like bv. I have no idea where that was documented anywhere, i just saw it used by other snippets. "here" is also a thing that my teammate found that we don't know where it is documented, or if other helpful little things like that we don't know about. Perhaps add some of that to the cookbook as well (unless I missed it elsewhere)
Lastly, the documentation for big classes like binaryview is soooooo long. Could you configure the documentation to compile a more concise index of sorts with links to the full documentation. Like Qt docs as an example: https://doc.qt.io/qt-6/qlist.html
The text was updated successfully, but these errors were encountered: