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

API docs should include a link to the docs on Python console and magic variables #6176

Open
xusheng6 opened this issue Nov 22, 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

Comments

@xusheng6
Copy link
Member

User discover https://docs.binary.ninja/dev/index.html via search engine, and they will start reading the docs on "Writing a Python plugin" when what they are looking for is actually https://docs.binary.ninja/guide/index.html#script-python-console and https://docs.binary.ninja/guide/index.html#magic-console-variables

@xusheng6 xusheng6 added Type: Enhancement Issue is a small enhancement to existing functionality 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 Nov 26, 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

1 participant