summaryrefslogtreecommitdiff
path: root/api-docs/source/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'api-docs/source/conf.py')
-rw-r--r--api-docs/source/conf.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py
index bc32e478..092710d5 100644
--- a/api-docs/source/conf.py
+++ b/api-docs/source/conf.py
@@ -102,6 +102,15 @@ Welcome to the Binary Ninja API documentation. The below methods are available
from the root of the `binaryninja` package, but most of the API is organized
into the modules shown in the left side-bar.
+These pages are intended as an API Reference. For a deeper explanation of how
+different parts of Binary Ninja work, explanations of concepts, or if you're
+new to Binary Ninja, you'll want to check out our [User Guide](https://docs.binary.ninja/).
+
+If you're new to our API, we also have a [Developer Guide](https://docs.binary.ninja/dev/index.html)
+which covers many of the concepts developers should know. There's also a
+[Cookbook](https://docs.binary.ninja/dev/cookbook.html) which contains many
+examples to get you started using our API.
+
You can also scroll to the end to view a class list of all available classes.
The search bar on the side works both online and offline.