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

Cookbook documentation on creating structures via API #5929

Open
mwales opened this issue Sep 13, 2024 · 0 comments
Open

Cookbook documentation on creating structures via API #5929

mwales opened this issue Sep 13, 2024 · 0 comments
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

Comments

@mwales
Copy link

mwales commented Sep 13, 2024

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

@psifertex psifertex added this to the Frogstar milestone Sep 19, 2024
@psifertex psifertex added Component: Documentation Issue needs changes to our documentation Impact: Low Issue is a papercut or has a good, supported workaround Effort: Trivial Issue should take < 1 day labels Sep 19, 2024
@xusheng6 xusheng6 added the Type: Enhancement Issue is a small enhancement to existing functionality label Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

3 participants