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

Open Beginner friendly

#6,176 opened on Nov 22, 2024 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 2/5
Estimated time: 1-3 hours
Newbie friendliness: 65/100

Issue type: Documentation
Clarity: Clearly specified
Activity status: Stale
Domain: documentation

Research direction

Start at the API documentation entry point at https://docs.binary.ninja/dev/index.html and review how users are directed to “Writing a Python plugin.” Add links to the guide sections for the Python console and magic console variables, then verify both links and their surrounding navigation work as intended.

Written by the indexing model from the issue text.

Description

Effort: Trivial Impact: Low

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

Dominant language: C++
Stars: 1.3k
Forks: 298
Avg merge: 4d 13h
Merged PRs (30d): 20

Contributor guide

No contributing guide indexed for this repository

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

Use 4:4:4 for multichannel AVIF and HEIF gain maps Open

Difficulty 2/5 1-3 hours Newbie friendliness 70/100

google/libultrahdr#485 · Opened Sep 24, 2026
Missing tile warnings in TileMap dock display with wrong texture filter Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

godotengine/godot#123776 · Opened Sep 23, 2026
if(cond,a,b) treats any nonzero cond as true in every bngsim backend (ExprTk interpreter, C codegen, SSA), which contradicts docs/reference/expressions.md ('true when > 0.5') and BNG's run_network. A non-boolean condition in (-inf,0) or... Open

bug

Difficulty 1/5 Under an hour Newbie friendliness 60/100

lanl/bngsim#774 · Opened Sep 23, 2026
Delete ament_export_include_directories() and ament_export_libraries() calls Open

good first issue

Difficulty 1/5 Under an hour Newbie friendliness 90/100

ros2/rosbag2#2509 · Opened Sep 23, 2026
Delete ament_export_include_directories() and ament_export_libraries() calls Open

good first issue

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

ros2/common_interfaces#344 · Opened Sep 23, 2026

More C++ issues