Skip to content

Commit 6b09d4d

Browse files
committed
fix images and some user manual links
1 parent 4942700 commit 6b09d4d

8 files changed

Lines changed: 64 additions & 64 deletions

File tree

docs/dev/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ILs in general are critical to how Binary Ninja analyzes binaries and we have mu
66

77
APIs that query these mappings are plural. So for example, while `current_hlil.llil` will give a single mapping, `current_hlil.llils` will return a list that may contain multiple mappings.
88

9-
![Mapping between ILs ><](/img/ilmapping.png "Mapping between ILs")
9+
![Mapping between ILs ><](./img/ilmapping.png "Mapping between ILs")
1010

1111
## Operating on IL versus Native
1212

docs/dev/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Using the Binary Ninja API
22

3-
Welcome to the Binary Ninja API documentation. Much like the [User Manual](/guide/), some larger sections have been split off into their own sections on the left, while the table of contents for this documentation is on the right.
3+
Welcome to the Binary Ninja API documentation. Much like the [User Manual](./guide/index.html), some larger sections have been split off into their own sections on the left, while the table of contents for this documentation is on the right.
44

55
## Language Specific Bindings
66

77
The Binary Ninja API is available through a [Core API](#core-api), through the [C++ API](#c-api), through a [Python API](#python-api), and a [Rust API](#rust-api).
88

99
### Python API
1010

11-
The most heavily documented of all of the APIs, the Python API serves as a useful documentation for the other APIs. Here's a list of the most important Python API documentation resources:
11+
The Python API is the most common third-party API and is used in many [public plugins](https://github.com/vector35/community-plugins). Here's a list of the most important Python API documentation resources:
1212

1313
- [Writing Python Plugins](plugins.md)
14-
- [Python API](https://api.binary.ninja/)
14+
- [Python API Reference](https://api.binary.ninja/) (available offline via the Help menu)
1515
- [API Source](https://github.com/Vector35/binaryninja-api/tree/dev/python)
1616

1717
### Core API

docs/getting-started.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Getting Started
22

3-
Welcome to Binary Ninja. This introduction document is meant to quickly guide you over some of the most common uses of Binary Ninja. If you're interested in more detailed information, check out the [User Manual](/guide/).
3+
Welcome to Binary Ninja. This introduction document is meant to quickly guide you over some of the most common uses of Binary Ninja. If you're interested in more detailed information, check out the [User Manual](guide/index.md).
44

5-
![main](/img/main.png "Main")
5+
![main](./img/main.png "Main")
66
## Installing Binary Ninja
77

88
The download links you receive after purchasing expire after 72hrs but as long as you have [active support](https://binary.ninja/faq/#updates) you can [request download links](https://binary.ninja/recover/) any time!
@@ -23,35 +23,35 @@ When you first run Binary Ninja, it will prompt you for your license key. You sh
2323

2424
## Opening Files
2525

26-
While there are [more ways than shown here](/guide/#loading-files), the most common ways to open a file are:
26+
While there are [more ways than shown here](./guide/index.md#loading-files), the most common ways to open a file are:
2727

2828
- Drag-and-drop
2929
- File Open
3030
- Run via CLI
3131

32-
But you can also change how analysis happens using [open with options](/guide/#loading-files).
32+
But you can also change how analysis happens using [open with options](./guide/index.md#loading-files).
3333

3434
## UI Basics
3535

36-
![Overview](/img/overview.png "Overview")
36+
![Overview](./img/overview.png "Overview")
3737

3838
By default, you'll see four main areas in Binary Ninja:
3939

40-
1. Symbol List (one of many [sidebars](guide/#the-sidebar))
41-
1. [Cross References](guide/#cross-references-pane)
42-
1. Main View (defaults to High Level IL and can have many [panes](guide/#tiling-panes))
43-
1. [Feature Map](guide/#feature-map)
40+
1. Symbol List (one of many [sidebars](./guide/index.md#the-sidebar))
41+
1. [Cross References](./guide/index.md#cross-references-pane)
42+
1. Main View (defaults to High Level IL and can have many [panes](./guide/index.md#tiling-panes))
43+
1. [Feature Map](guide/index.md#feature-map)
4444

45-
Not enabled by default but can be made visible is the global area which includes the [scripting console](guide/#script-python-console) and log window.
45+
Not enabled by default but can be made visible is the global area which includes the [scripting console](guide/index.md#script-python-console) and log window.
4646

47-
Make sure to check out the many view options available in the various ☰ ("hamburger") menus. However, most configuration settings are available in the [settings](guide/#settings) menu. (`[CMD/CTRL] ,` is the hotkey for settings)
47+
Make sure to check out the many view options available in the various ☰ ("hamburger") menus. However, most configuration settings are available in the [settings](./guide/index.md#settings) menu. (`[CMD/CTRL] ,` is the hotkey for settings)
4848
in the top right of each pane allows for additional customization, including locking the pane to a single function.
4949

5050
### Interacting
5151

52-
![command palette](/img/command-palette.png "Command Palette")
52+
![command palette](./img/command-palette.png "Command Palette")
5353

54-
One of the most useful features of Binary Ninja is that everything can be quickly and easily accessed through a [command-palette](/guide/#command-palette) (`[CMD/CTRL] p`). You'll be surprised how often it saves you from looking through menus to find out just what you need. Also, any action in the command-palette can be changed to a [custom hotkey](/guide/#custom-hotkeys). That said, here are a few of the more useful default hotkeys:
54+
One of the most useful features of Binary Ninja is that everything can be quickly and easily accessed through a [command-palette](./guide/index.md#command-palette) (`[CMD/CTRL] p`). You'll be surprised how often it saves you from looking through menus to find out just what you need. Also, any action in the command-palette can be changed to a [custom hotkey](./guide/index.md#custom-hotkeys). That said, here are a few of the more useful default hotkeys:
5555

5656
- `[ESC]` : Navigate backward
5757
- `[SPACE]` : Toggle between linear view and graph view
@@ -66,29 +66,29 @@ One of the most useful features of Binary Ninja is that everything can be quickl
6666
- `r` : Change the data type to single ASCII character
6767
- `o` : Create a pointer data type
6868

69-
For more hotkeys, see the [User Manual](/guide/).
69+
For more hotkeys, see the [User Manual](./guide/index.md).
7070

7171

7272
## Intermediate Languages
7373

74-
Binary Ninja is one of the most advanced binary analysis platforms, and it has a unique stack of related intermediate languages. If that gets you excited, you'll surely want to check out the [developer guide](/dev/bnil-overview.md) for more information. If it doesn't mean anything to you, no worries, here's a few tips to make your life easier. The default view is "High Level IL". It looks and reads almost like pseudo code. There's a few extra notations (usually just around comparisons for whether they are signed or not, or between moves of data indicating the size of the operation) but it should otherwise be very understandable. If you prefer disassembly or even [Pseudo C](/guide/#pseudo-c) as your default view, no worries, just check out the `UI`/`view.graph` and `view.linear` settings.
74+
Binary Ninja is one of the most advanced binary analysis platforms, and it has a unique stack of related intermediate languages. If that gets you excited, you'll surely want to check out the [developer guide](./dev/bnil-overview.md) for more information. If it doesn't mean anything to you, no worries, here's a few tips to make your life easier. The default view is "High Level IL". It looks and reads almost like pseudo code. There's a few extra notations (usually just around comparisons for whether they are signed or not, or between moves of data indicating the size of the operation) but it should otherwise be very understandable. If you prefer disassembly or even [Pseudo C](./guide/index.md#pseudo-c) as your default view, no worries, just check out the `UI`/`view.graph` and `view.linear` settings.
7575

7676
## Using Plugins
7777

78-
Plugins can be installed by one of two methods. First, they can be manually installed by copying the plugin to the appropriate [folder](guide/#user-folder), or using the [Plugin Manager](guide/plugins.md#plugin-manager).
78+
Plugins can be installed by one of two methods. First, they can be manually installed by copying the plugin to the appropriate [folder](./guide/index.md#user-folder), or using the [Plugin Manager](./guide/plugins.md#plugin-manager).
7979

8080
## Debugger
8181

8282
Binary Ninja includes a debugger that can debug executables on Windows, Linux, and macOS.
8383

84-
For more detailed information, see the [debugger guide](/guide/debugger.md).
84+
For more detailed information, see the [debugger guide](./guide/debugger.md).
8585

8686
## Updates
8787

88-
While Binary Ninja automatically updates itself, by default you will only use the Stable Branch and you can check out features much faster on the development branch using the [update channel](guide/#updates) dialog.
88+
While Binary Ninja automatically updates itself, by default you will only use the Stable Branch and you can check out features much faster on the development branch using the [update channel](./guide/index.md#updates) dialog.
8989

9090
## What's next?
9191

92-
- Consider writing your first [plugin](/dev/)
92+
- Consider writing your first [plugin](./dev/index.md)
9393
- Watch our [Binary Ninja Basics](https://www.youtube.com/watch?v=xKBQatwshs0&list=PLCVV6Y9LmwOgqqT5obf0OmN9fp5495bLr) videos
94-
- Read the rest of the more detailed [User Manual](/guide/)
94+
- Read the rest of the more detailed [User Manual](./guide/index.md)

0 commit comments

Comments
 (0)